Um módulo para a consulta de endereços usando o Web Service da ViaCep.
- Fácil manipulação.
- Retorna todos os formatos (Json, Xml, Piped, Querty).
- Uso da Interface Fluent.
- Uso de Callback Methods.
Primeiro você precisa instanciar um objeto da classe ViaCepService.
var viaCepService = ViaCepService.Default();Existem duas formas de consultar endereços.
- Consultando por Cep.
Crie um objeto do tipo Cep ou use uma string se preferir.
Cep cep = "01001000";
var endereco = viaCepService.ObterEndereco(cep); // viaCep.ObterEndereco("01001000");Nesse caso o endereço será retornado como um objeto do tipo Endereco. Se desejar retornar como outros formatos:
var enderecoJson = viaCepService.ObterEnderecoComoJson(cep); //viaCepService.ObterEnderecoComoJson("01001000");Você ainda pode retornar com Xml, Piped, ou Querty utilizando os métodos ObterEnderecoComoXml , ObterEnderecoComoPiped e
ObterEnderecoComoQuerty, respectivamente, ambos métodos da classe ViaCepService.
- Consultando por Endereco
A consulta também pode ser realizada a partir de três parâmetros: Sigla do estado, Nome da Cidade, e Nome do Logradouro.
var requisicao = new EnderecoRequisicao {
UF = UF.RS,
Cidade = "Porto Alegre",
Logradouro = "Olavo"
};
var enderecos = viaCepService.ObterEnderecos(requisicao);Neste exemplo será pesquisado na cidade de "Porto Algre/RS" por todos os logradouros que contenham "Olavo" em seu nome. Quando o nome da cidade ou do logradouro não contiver ao menos três caracteres será lançado uma Exception;
O resultado desta consulta é um IEnumerable<Endereco> contendo todos os resultados. Caso nenhum endereço seja encontrado uma lista vazia será retornada.
Use os métodos ObterEnderecosComoJson e ObterEnderecosComoXml, ambos da classe ViaCepService, para retornar os resultados nos formatos
Json e Xml, respectivamente.
A classe ViaCepService também fornece métodos assíncronos.
var xml = await viaCepService.ObterEnderecoComoXmlAsync("01001000");- Fluent Interface
Para facilitar ainda mais as consultas utilize a Fluent Interface veja como é simples.
ViaCepFluent.RequisicaoPorCep
.ComOsDados("01001000")
.RetorneComoJson(Console.WriteLine);A novidade é poder capturar e tratar qualquer Exception lançada.
var cep = "01001000";
await ViaCepFluent.RequisicaoPorCep
.ComOsDados(cep)
.Capture(e => Console.WriteLine($"Erro ao tentar consultar o endereço com o Cep {cep}. Descrição: {e.Message}"))
.RetorneComoEnderecoAsync(Console.WriteLine);Você pode consultar mais sobre fluent aqui.
Se você estiver utilizando o SimpleInjector:
var container = new SimpleInjector.Container();
container.Options.DefaultScopedLifestyle = new WebRequestLifestyle();
container.Register<IViaCepService, ViaCepService>();
container.Register<IViaCepCliente, ViaCepCliente>();
container.Register<IEnderecoConvert, EnderecoConvert>();
container.Register<IViaCepRequisicaoPorCepFactory, ViaCepRequisicaoPorCepFactory>();
container.Register<IViaCepRequisicaoPorEnderecoFactory, ViaCepRequisicaoPorEnderecoFactory>();
container.RegisterMvcControllers(Assembly.GetExecutingAssembly());
DependencyResolver.SetResolver(new SimpleInjectorDependencyResolver(container));Depois basta injetar a Dependência via Construtor.
public class EmpresaController : Controller
{
private readonly IViaCepService _viaCepService;
public EmpresaController(IViaCepService viaCepService)
{
_viaCepService = viaCepService;
}
public Task<ActionResult> Index()
{
var endereco = await _viaCepService.ObterEnderecoAsync("01001000");
return View(endereco);
}
}Newtonsoft.Json >= 11.0.1