java controller 返回中文乱码统一处理

原创

mob649e816594b7 2024-10-28 04:30:20 ©著作权

©著作权归作者所有：来自51CTO博客作者mob649e816594b7的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java Controller 返回中文乱码的统一处理

在Java Web开发中，我们经常需要处理中文字符的传递与显示。然而，由于编码不一致，中文字符有时会出现乱码问题。在本文中，我们将讨论如何统一处理Java Controller中的中文乱码，并提供相关示例代码，帮助开发者避免常见的错误。

中文乱码的原因

中文乱码通常是由于字符编码不一致造成的。Java使用UTF-8编码，而浏览器和数据库的编码设置如果不一致，就会导致乱码现象。常见的编码包括UTF-8、ISO-8859-1和GBK等。为了统一处理字符编码，我们需要确保在项目的各个环节设置一致的编码格式。

解决方案

以下是处理中文乱码的几个主要步骤：

设置Servlet编码：确保Servlet或Controller返回的数据使用UTF-8编码。
配置Web.xml：在web.xml中配置字符编码的过滤器。
数据库编码：确保数据库的编码设置为UTF-8。

1. 设置Servlet编码

在Controller中，使用HttpServletRequest和HttpServletResponse设置字符编码为UTF-8：

@RestController
public class MyController {

    @GetMapping("/test")
    public ResponseEntity<String> test(HttpServletRequest request, HttpServletResponse response) {
        try {
            request.setCharacterEncoding("UTF-8"); // 设置请求编码
            response.setContentType("text/html;charset=UTF-8"); // 设置响应编码
            return ResponseEntity.ok("测试中文返回");
        } catch (Exception e) {
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("错误");
        }
    }
}

2. 配置Web.xml

在 web.xml 中配置字符编码过滤器，可以确保所有请求都使用UTF-8编码：

<filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

3. 数据库编码

确保数据库的连接编码与应用一致，例如MySQL：

ALTER DATABASE your_database_name CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

另外，在数据库连接URL中也需要指定字符集：

jdbc:mysql://localhost:3306/your_database_name?useUnicode=true&characterEncoding=utf8

理论与实践相结合的示例

通过以上步骤，我们可以有效地避免中文乱码的问题。以下是一个简单的ER图，展示了与中文字符传递相关的数据库设计。

erDiagram
    USER {
        int id PK
        string name
        string email
    }
    MESSAGE {
        int id PK
        int userId FK
        string content
    }
    USER ||--o| MESSAGE : sends