javajson接口怎么写

Java中JSON接口的编写指南

在Java开发中,JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，广泛应用于前后端数据交互、API接口开发等场景，编写Java JSON接口的核心目标是将后端业务数据转换为JSON格式返回给前端，或解析前端传来的JSON数据，本文将详细介绍Java中JSON接口的编写方法，包括常用工具、接口实现步骤及最佳实践。

JSON接口开发的核心流程

编写一个完整的JSON接口通常包含以下步骤：

1. 定义接口数据模型：根据业务需求设计Java类（POJO/DTO），作为JSON数据与Java对象的载体。
2. 选择JSON工具库：将Java对象序列化为JSON字符串（响应），或反序列化JSON字符串为Java对象（请求）。
3. 实现接口逻辑：处理业务数据，调用JSON工具完成转换。
4. 返回JSON响应：通过Web框架（如Spring Boot）将JSON数据返回给客户端。

常用JSON工具库

Java生态中有多种JSON处理工具,以下是主流库的对比及选择建议：

推荐选择：优先使用Jackson（Spring Boot默认）或Gson，兼顾性能与生态兼容性。

基于Spring Boot的JSON接口编写实践

Spring Boot作为当前主流的Java开发框架，内置了Jackson支持，可快速实现JSON接口，以下以Spring Boot为例，分步骤说明编写方法。

环境准备

（1）创建Spring Boot项目

通过Spring Initializr创建项目，添加以下依赖：

• spring-boot-starter-web：提供Web开发支持（内置Jackson）。
• lombok：简化POJO代码（可选）。

（2）依赖示例（Maven）

<dependencies>
    <!-- Spring Boot Web Starter（内置Jackson） -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- Lombok（简化getter/setter） -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

定义JSON数据模型（POJO/DTO）

根据接口返回的JSON结构,定义对应的Java类，用户信息接口可能返回如下JSON：

{
    "code": 200,
    "message": "success",
    "data": {
        "id": 1,
        "username": "zhangsan",
        "age": 25
    }
}

对应的Java类（使用Lombok简化代码）：

// 响应包装类（统一返回格式）
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ApiResponse<T> {
    private int code;
    private String message;
    private T data;
}
// 用户数据模型
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String username;
    private Integer age;
}

实现JSON接口逻辑

通过@RestController注解定义控制器，处理HTTP请求并返回JSON数据，Spring Boot会自动将Java对象序列化为JSON（通过Jackson的HttpMessageConverter）。

示例1：返回简单JSON对象

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api/users")
public class UserController {
    @GetMapping("/1")
    public ApiResponse<User> getUserById() {
        // 模拟业务逻辑：查询用户
        User user = new User(1L, "zhangsan", 25);
        // 包装为统一响应格式
        return new ApiResponse<>(200, "success", user);
    }
}

访问接口：启动Spring Boot项目后，访问http://localhost:8080/api/users/1，浏览器会返回：

{
    "code": 200,
    "message": "success",
    "data": {
        "id": 1,
        "username": "zhangsan",
        "age": 25
    }
}

示例2：接收JSON请求并返回JSON

接口不仅需要返回JSON,还需解析前端传来的JSON数据（如POST请求的请求体），使用@RequestBody注解自动将JSON反序列化为Java对象。

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
@RestController
@RequestMapping("/api/users")
public class UserController {
    @PostMapping
    public ApiResponse<User> createUser(@RequestBody User user) {
        // 模拟业务逻辑：创建用户（生成ID）
        Long newId = System.currentTimeMillis() % 1000; // 模拟ID生成
        User createdUser = new User(newId, user.getUsername(), user.getAge());
        return new ApiResponse<>(201, "user created", createdUser);
    }
}

测试接口：使用Postman或curl发送POST请求，请求体为JSON：

{
    "username": "lisi",
    "age": 30
}

响应结果：

{
    "code": 201,
    "message": "user created",
    "data": {
        "id": 123,
        "username": "lisi",
        "age": 30
    }
}

处理复杂数据结构

（1）嵌套对象与集合

如果JSON数据包含嵌套对象或集合（如用户列表），直接在POJO中定义对应类型即可。

示例：返回用户列表

import java.util.List;
@RestController
@RequestMapping("/api/users")
public class UserController {
    @GetMapping
    public ApiResponse<List<User>> getAllUsers() {
        // 模拟查询用户列表
        List<User> users = List.of(
            new User(1L, "zhangsan", 25),
            new User(2L, "lisi", 30)
        );
        return new ApiResponse<>(200, "success", users);
    }
}

响应结果：

{
    "code": 200,
    "message": "success",
    "data": [
        {
            "id": 1,
            "username": "zhangsan",
            "age": 25
        },
        {
            "id": 2,
            "username": "lisi",
            "age": 30
        }
    ]
}

（2）日期格式处理

默认情况下,Jackson会将日期序列化为时间戳（如1678886400000），但前端通常需要yyyy-MM-dd HH:mm:ss格式，可通过@JsonFormat注解自定义日期格式。

示例：添加生日字段

@Data
public class User {
    private Long id;
    private String username;
    private Integer age;
    @JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8") // 日期格式化
    private Date birthday;
}

响应结果（假设生日为1998-01-01）：

{
    "code": 200,
    "message": "success",
    "data": {
        "id": 1,
        "username": "zhangsan",
        "age": 25,
        "birthday": "1998-01-01"
    }
}

（3）字段过滤与重命名

• 过滤字段：使用@JsonIgnore注解忽略某个字段（如密码），不参与JSON序列化。

  @Data
  public class User {
      private Long id;
      private String username;
      @JsonIgnore // 忽略password字段
      private String password;
  }

• 重命名字段：使用@JsonProperty注解修改JSON字段名。

  @Data
  public class User {
      @JsonProperty("user_id") // JSON中显示为user_id
      private Long id;
      private String username;
  }

非Spring Boot环境下的JSON接口编写

若不使用Spring Boot，可手动集成Jackson或Gson实现JSON接口，以下以Servlet + Jackson为例：

添加依赖

<!-- Jackson核心库 -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>