{"id":521,"date":"2017-04-12T18:39:56","date_gmt":"2017-04-12T21:39:56","guid":{"rendered":"http:\/\/gianfratti.com\/?p=521"},"modified":"2017-04-12T18:47:28","modified_gmt":"2017-04-12T21:47:28","slug":"comprimindo-a-resposta-de-uma-webapi-ativando-a-compactacao-gzip","status":"publish","type":"post","link":"https:\/\/gianfratti.com\/index.php\/comprimindo-a-resposta-de-uma-webapi-ativando-a-compactacao-gzip\/","title":{"rendered":"Comprimindo a resposta de uma WebApi ativando a compacta\u00e7\u00e3o GZIP"},"content":{"rendered":"

Um dos maiores desafios de uma WebApi \u00e9 como fazer com que os clientes usem a API o m\u00ednimo poss\u00edvel para n\u00e3o haver sobrecarga. Uma das formas mais simples de fazer com que o servidor fique menos carregado \u00e9 comprimir a resposta dada pela WebApi. Vamos aprender como neste artigo.<\/p>\n

A compacta\u00e7\u00e3o GZIP, que vamos aplicar numa WebApi, permite compactar a resposta das chamadas em at\u00e9 90%. Estamos diminuindo o tempo de comunica\u00e7\u00e3o de dados entre API e cliente em troca do processamento extra na API compactando os dados. Ou seja, se sua WebApi est\u00e1 hospedada num servidor com um processador muito fraco, o resultado pode n\u00e3o ser o esperado.<\/p>\n

Isto posto, vamos imaginar o seguinte cen\u00e1rio. Eu criei uma WebApi bem simples, devolvendo uma lista de objetos do tipo Pessoa<\/code>.<\/p>\n

\n
\n

 <\/p>\n

\r\npublic class Pessoa\r\n{\r\n\u00a0\u00a0\u00a0 public string Nome { get; set; }\r\n\u00a0\u00a0\u00a0 public string Salario { get; set; }\r\n\u00a0\u00a0\u00a0 public string CorDosOlhos { get; set; }\r\n\u00a0\u00a0\u00a0 public int Idade { get; set; }\r\n\u00a0\u00a0\u00a0 public string Email { get; set; }\r\n\u00a0\u00a0\u00a0 public string Contato { get; set; }\r\n\u00a0\u00a0\u00a0 public string DataDeRegistro { get; set; }\r\n}\r\n<\/pre>\n<\/div>\n
\n
Eu simplesmente estou trazendo um conjunto de 100 pessoas transformando List<Pessoa><\/code> e devolvendo o resultado.<\/p>\n
\r\npublic class HomeController : ApiController\r\n{\r\n\u00a0\u00a0\u00a0 public List<Pessoa> Get()\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return JsonConvert.DeserializeObject<List<Pessoa>>(Resources.Informacao);\r\n\u00a0\u00a0\u00a0 }\r\n}\r\n<\/pre>\n<\/div>\n
Testando localmente esta WebApi usando o Postman<\/a>, vemos que o retorno tem aproximadamente 20 KBs de tamanho. Olhando de forma individual, 20 KBs n\u00e3o s\u00e3o nada. Mas imagine uma API acessada por v\u00e1rios clientes, e de forma simult\u00e2nea. Qualquer forma de agilizar a resposta \u00e9 v\u00e1lida.
\n\"\"<\/div>\n
<\/div>\n
Precisamos instalar alguns pacotes NuGet para ativar a compress\u00e3o de WebApis. Selecione o projeto da WebApi e acesse o menu Tools > NuGet Package Manager > Package Manager Console<\/strong>.<\/div>\n<\/div>\n
<\/div>\n
\"\"<\/div>\n
<\/div>\n
\n
Precisamos instalar os pacotes Microsoft.AspNet.WebApi.Extensions.Compression.Server<\/strong> e System.Net.Http.Extensions.Compression.Client<\/strong>. Voc\u00ea precisa usar o comando Install-Package<\/strong> para fazer a instala\u00e7\u00e3o. Digite as duas linhas abaixo, uma por vez:<\/p>\n
Install-Package Microsoft.AspNet.WebApi.Extensions.Compression.Server<\/strong><\/p>\n
Install-Package System.Net.Http.Extensions.Compression.Client<\/strong><\/p>\n
\"\"<\/p>\n
Agora com ambos os pacotes instalados, acesse o arquivo Global.asax<\/strong> e adicione a linha abaixo. Basicamente, estamos criando um novo MessageHandler<\/code> para aplicar a compress\u00e3o GZip em todas as chamadas da WebApi.<\/p>\n
\n
\n
\r\nGlobalConfiguration.Configuration\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .MessageHandlers\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .Insert(0, new ServerCompressionHandler(new GZipCompressor(), new DeflateCompressor()));\r\n<\/pre>\n<\/div>\n
Veja como fica a classe WebApiApplication<\/code> do arquivo Global.asax<\/strong>:<\/div>\n
\n
\r\npublic class WebApiApplication : System.Web.HttpApplication\r\n{\r\n\u00a0\u00a0\u00a0 protected void Application_Start()\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 GlobalConfiguration.Configuration\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .MessageHandlers\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 .Insert(0, new ServerCompressionHandler(new GZipCompressor(), new DeflateCompressor()));\r\n\u00a0\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 GlobalConfiguration.Configure(WebApiConfig.Register);\r\n\u00a0\u00a0\u00a0 }\r\n}\r\n<\/pre>\n<\/div>\n
\n
E se testarmos novamente nossa WebApi, o tamanho da resposta caiu cerca de 75%, para cerca de 5 KBs!<\/p>\n<\/div>\n<\/div>\n<\/div>\n
\"\"<\/div>\n
<\/div>\n
Como visto, estamos adicionando um processamento extra em nossa WebApi em troca de uma vis\u00edvel economia no tr\u00e1fego de rede, fazendo com que a resposta fique menor e mais r\u00e1pida. Uma forma f\u00e1cil de desafogar o tr\u00e1fego de uma API sem perda de recursos. At\u00e9 a pr\u00f3xima!<\/div>\n","protected":false},"excerpt":{"rendered":"
Um dos maiores desafios de uma WebApi \u00e9 como fazer com que os clientes usem a API o m\u00ednimo poss\u00edvel para n\u00e3o haver sobrecarga. Uma das formas mais simples de fazer com que o servidor fique menos carregado \u00e9 comprimir a resposta dada pela WebApi. Vamos aprender como neste artigo. …<\/span> Read More →<\/span><\/a><\/span><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_exactmetrics_skip_tracking":false,"_exactmetrics_sitenote_active":false,"_exactmetrics_sitenote_note":"","_exactmetrics_sitenote_category":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[2],"tags":[100,99],"class_list":["post-521","post","type-post","status-publish","format-standard","hentry","category-net-framework","tag-gzip","tag-webapi"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/gianfratti.com\/index.php\/wp-json\/wp\/v2\/posts\/521","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/gianfratti.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/gianfratti.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/gianfratti.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/gianfratti.com\/index.php\/wp-json\/wp\/v2\/comments?post=521"}],"version-history":[{"count":5,"href":"https:\/\/gianfratti.com\/index.php\/wp-json\/wp\/v2\/posts\/521\/revisions"}],"predecessor-version":[{"id":530,"href":"https:\/\/gianfratti.com\/index.php\/wp-json\/wp\/v2\/posts\/521\/revisions\/530"}],"wp:attachment":[{"href":"https:\/\/gianfratti.com\/index.php\/wp-json\/wp\/v2\/media?parent=521"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/gianfratti.com\/index.php\/wp-json\/wp\/v2\/categories?post=521"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/gianfratti.com\/index.php\/wp-json\/wp\/v2\/tags?post=521"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}