在 Java Servlet 中返回包含中文字符的 JSON 响应时,如果前端出现了乱码问题,通常是由于字符编码设置不正确导致的。为了确保中文字符能够正确显示,需要在设置响应内容类型的同时,指定字符编码为 UTF-8。以下是解决该问题的具体步骤:
- 设置响应内容类型和字符编码:使用
setContentType
方法设置内容类型为application/json;charset=UTF-8
。 - 设置响应字符编码:使用
setCharacterEncoding
方法设置字符编码为UTF-8
。
下面是修改后的示例代码:
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
public class CustomErrorServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
sendCustomError(resp, 400, "请求参数无效");
}
private void sendCustomError(HttpServletResponse response, int statusCode, String errorMessage) throws IOException {
response.setStatus(statusCode);
response.setContentType("application/json;charset=UTF-8");
response.setCharacterEncoding("UTF-8");
PrintWriter out = response.getWriter();
out.print("{");
out.print("\"error\": \"" + errorMessage + "\"");
out.print("}");
out.flush();
}
}
关键步骤解析:
-
设置响应内容类型和字符编码:
java
response.setContentType("application/json;charset=UTF-8");
通过设置
charset=UTF-8
,可以确保响应的内容类型和字符编码一起设置。 -
设置响应字符编码:
java
response.setCharacterEncoding("UTF-8");
明确指定响应使用 UTF-8 编码,以确保中文字符不出现乱码。
整体流程:
response.setStatus(statusCode);
:设置 HTTP 状态码。response.setContentType("application/json;charset=UTF-8");
:设置内容类型为 JSON,并指定字符编码为 UTF-8。response.setCharacterEncoding("UTF-8");
:再次明确字符编码为 UTF-8。- 使用
PrintWriter
输出 JSON 格式的错误信息,其中包含中文字符。
这样,前端接收到的 JSON 响应将包含正确显示的中文字符。
添加过之后,返回的头里面content-type 还是有ISO-8859-1
在某些情况下,即使你在代码中设置了响应的 Content-Type
和字符编码,Tomcat 等 Servlet 容器可能会默认使用 ISO-8859-1
编码。为了确保 Content-Type
和字符编码设置正确,可以在设置内容类型和字符编码之前调用 response.setCharacterEncoding("UTF-8")
方法。
以下是更新后的代码,确保在设置 Content-Type
和字符编码时顺序正确:
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
public class CustomErrorServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
sendCustomError(resp, 400, "请求参数无效");
}
private void sendCustomError(HttpServletResponse response, int statusCode, String errorMessage) throws IOException {
response.setCharacterEncoding("UTF-8");
response.setContentType("application/json;charset=UTF-8");
response.setStatus(statusCode);
PrintWriter out = response.getWriter();
out.print("{");
out.print("\"error\": \"" + errorMessage + "\"");
out.print("}");
out.flush();
}
}
关键步骤解析:
-
首先设置字符编码:
java
response.setCharacterEncoding("UTF-8");
这一步是确保后续的内容类型和输出流使用的是 UTF-8 编码。
-
设置内容类型,并包含字符编码:
java
response.setContentType("application/json;charset=UTF-8");
这一步设置内容类型为 JSON,并确保字符编码为 UTF-8。
-
设置状态码:
java
response.setStatus(statusCode);
-
输出 JSON 响应: 使用
PrintWriter
向响应写入 JSON 格式的错误描述,确保中文字符不出现乱码。
通过确保字符编码的设置顺序和内容类型的正确设置,你可以避免 ISO-8859-1
编码的问题。这样,前端接收到的 JSON 响应将包含正确显示的中文字符。