Java JSON返回案例怎么编写

wen java案例 2026-06-30 24

本文目录导读：

Java JSON返回案例怎么编写

目录导读
为什么Java项目必须掌握JSON返回
第一步：环境搭建与依赖引入
基础案例：使用Servlet手动返回JSON
进阶案例：Spring Boot自动序列化JSON
高级技巧：定制JSON返回格式
常见问题问答（FAQ）

Java JSON返回案例怎么编写？从零到实战的完整指南

目录导读

为什么Java项目必须掌握JSON返回 —— 理解JSON在后端开发中的核心地位
第一步：环境搭建与依赖引入 —— Maven/Gradle配置与常用库选择
基础案例：使用Servlet手动返回JSON —— 最原始但最清晰的实现方式
进阶案例：Spring Boot自动序列化JSON —— 企业级最常用解决方案
高级技巧：定制JSON返回格式 —— 日期处理、字段过滤与全局配置
常见问题问答（FAQ） —— 涵盖编码异常、循环引用、大数据性能等痛点

为什么Java项目必须掌握JSON返回

在现代Web开发中，前后端分离已成为主流架构，JSON（JavaScript Object Notation）凭借其轻量级、易解析、跨语言兼容的特性，成为数据交换的事实标准，无论是API接口、微服务通信还是移动端数据交互，JSON返回都是后端开发者的基本功。

如果JSON格式不规范、字段命名混乱或处理错误，轻则导致前端解析失败，重则引发安全漏洞，从最简单的案例开始系统学习JSON返回编写,是Java开发者提升工程能力的关键一步。

第一步：环境搭建与依赖引入

1 核心依赖选择

Java处理JSON的主流库有三种：

Jackson（Spring Boot默认集成，功能全面）
Gson（Google出品，轻量易用）
Fastjson（阿里巴巴贡献，性能极优但需注意版本bug）

推荐初学用Jackson,企业级项目也最稳定。

2 Maven配置示例

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.15.2</version>
</dependency>

注意：Spring Boot项目中无需单独引入，因为spring-boot-starter-web已包含Jackson。

基础案例：使用Servlet手动返回JSON

1 核心代码实现

import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
public class JsonReturnServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
        // 1. 设置响应头
        resp.setContentType("application/json;charset=UTF-8");
        resp.setCharacterEncoding("UTF-8");
        // 2. 准备数据
        Map<String, Object> result = new HashMap<>();
        result.put("code", 200);
        result.put("message", "success");
        result.put("data", "Hello JSON");
        // 3. 序列化为JSON并输出
        ObjectMapper mapper = new ObjectMapper();
        String json = mapper.writeValueAsString(result);
        resp.getWriter().write(json);
    }
}

2 运行结果

前端收到的响应：

{"code":200,"message":"success","data":"Hello JSON"}

关键点：务必设置Content-Type: application/json,否则前端会按纯文本解析。

进阶案例：Spring Boot自动序列化JSON

1 @RestController注解

Spring Boot通过@RestController（等价于@Controller + @ResponseBody）自动将返回值转为JSON。

@RestController
@RequestMapping("/api")
public class UserController {
    @GetMapping("/user/{id}")
    public User getUser(@PathVariable Long id) {
        User user = new User();
        user.setId(id);
        user.setName("小明");
        user.setEmail("xiaoming@example.com");
        return user;  // Spring自动序列化为JSON
    }
}

对应的User实体类：

public class User {
    private Long id;
    private String name;
    private String email;
    // getter/setter 必须提供，Jackson依赖它们生成JSON
}

2 统一返回结构

企业级项目通常会包装一个统一的响应类来实现全局返回规范：

public class Result<T> {
    private int code;
    private String msg;
    private T data;
    public static <T> Result<T> success(T data) {
        Result<T> r = new Result<>();
        r.code = 200;
        r.msg = "成功";
        r.data = data;
        return r;
    }
    public static <T> Result<T> error(int code, String msg) {
        Result<T> r = new Result<>();
        r.code = code;
        r.msg = msg;
        return r;
    }
    // getter/setter
}

使用方式：

@GetMapping("/users")
public Result<List<User>> getUsers() {
    List<User> list = userService.findAll();
    return Result.success(list);
}

返回示例：

{"code":200,"msg":"成功","data":[{"id":1,"name":"张三"},{"id":2,"name":"李四"}]}

高级技巧：定制JSON返回格式

1 日期格式化

默认Jackson将日期序列化为时间戳,需手动配置：

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date createTime;

或在全局配置文件application.yml中统一设置：

spring:
  jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8

2 字段过滤与忽略

如果不想返回某些敏感字段（如密码），使用@JsonIgnore：

public class User {
    private String username;
    @JsonIgnore
    private String password;  // 序列化时忽略
}

3 动态字段名映射

当需要将Java字段名改为其他键名（如Java的userName转为JSON的user_name），使用@JsonProperty：

@JsonProperty("user_name")
private String userName;

4 全局统一配置

在Spring Boot中创建配置类：

@Configuration
public class JacksonConfig {
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer customizer() {
        return builder -> builder
            .serializerByType(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")))
            .deserializerByType(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
    }
}

常见问题问答（FAQ）

Q1：为什么返回的JSON字段名字是驼峰，但前端要求是下划线？

答：使用@JsonProperty注解覆盖默认字段名，或通过全局配置PropertyNamingStrategy.SNAKE_CASE：

spring.jackson.property-naming-strategy: SNAKE_CASE

Q2：Java对象中有循环引用导致JSON序列化失败怎么办？

答：在关联属性上添加@JsonIgnoreProperties({"associatedField"})或使用@JsonBackReference / @JsonManagedReference，Spring Boot还可以配置：

@Bean
public Jackson2ObjectMapperBuilder objectMapperBuilder() {
    Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
    builder.featuresToDisable(SerializationFeature.FAIL_ON_SELF_REFERENCES);
    builder.featuresToEnable(SerializationFeature.INDENT_OUTPUT);
    return builder;
}

Q3：返回大数据量时速度很慢怎么办？

答：

考虑使用流式JSON输出（如JsonGenerator）而非内存构建
对集合使用分页查询，避免一次性返回数万条数据
开启Jackson的WRITE_BIGDECIMAL_AS_PLAIN避免科学计数法
升级至Fastjson并启用JSON.toJSONString(object, SerializerFeature.DisableCircularReferenceDetect)