1. Overview

1.概述

In this article, we’ll learn about CharacterEncodingFilter and it’s usage in a Spring Boot application.

在本文中，我们将了解CharacterEncodingFilter以及它在Spring Boot应用程序中的用法。

2. CharacterEncodingFilter

2.CharacterEncodingFilter

CharacterEncodingFilter is a servlet filter that helps us to specify a character encoding for requests and responses. This filter is useful when browsers do not set a character encoding or if we want a specific interpretation for requests and responses.

CharacterEncodingFilter 是一个servlet过滤器，帮助我们 为请求和响应指定一个字符编码。当浏览器没有设置字符编码，或者我们想为请求和响应提供特定的解释时，这个过滤器就很有用。

3. Implementation

3.实施

Let’s see how we can configure this filter in a Spring Boot application.

让我们看看如何在Spring Boot应用程序中配置这个过滤器。

First, let’s create a CharacterEncodingFilter:

首先，让我们创建一个CharacterEncodingFilter：。

CharacterEncodingFilter filter = new CharacterEncodingFilter();
filter.setEncoding("UTF-8");
filter.setForceEncoding(true);

In our example, we have set the encoding as UTF-8. But, we can set any other encoding based on the requirement.

在我们的例子中，我们将编码设置为UTF-8。但是，我们可以根据需要设置任何其他编码。

We have also used forceEncoding attribute to enforce the encoding irrespective of its presence in request from the browser. Since this flag is set as true, the provided encoding will also be applied as response encoding.

我们还使用了forceEncoding属性来强制执行编码，而不管浏览器的请求中是否存在编码。由于这个标志被设置为true，所提供的编码也将被应用为响应编码。

Finally, we’ll register the filter with FilterRegistrationBean which provides configuration to register Filter instances as part of the filter chain:

最后，我们将用FilterRegistrationBean注册过滤器，它提供配置来注册Filter实例作为过滤器链的一部分。

FilterRegistrationBean registrationBean = new FilterRegistrationBean();
registrationBean.setFilter(filter);
registrationBean.addUrlPatterns("/*");
return registrationBean;

In non-spring boot applications, we can add this filter in the web.xml file to get the same effect.

在非spring boot应用程序中，我们可以在web.xml文件中添加这个过滤器以获得同样的效果。

4. Conclusion

4.总结

In this article, we’ve described the need for CharacterEncodingFilter and seen an example of its configuration.

在这篇文章中，我们描述了对CharacterEncodingFilter的需求，并看到了一个配置的例子。

As always, the complete code for this article is available over on GitHub.

一如既往，本文的完整代码可在GitHub上获得。