spring如何收发json数据

Spring Boot中高效收发JSON数据的完整指南

在当今的Web开发中，JSON（JavaScript Object Notation）已成为数据交换的事实标准，Spring框架作为Java生态中最流行的开发框架之一，提供了强大而灵活的支持来处理JSON数据的收发，本文将详细介绍如何在Spring Boot应用中高效地接收和发送JSON数据,涵盖从基础配置到高级用法的各个方面。

准备工作：添加JSON处理依赖

Spring Boot 2.x及以上版本默认使用Jackson库处理JSON数据，但如果你需要其他JSON库的支持（如Gson或JSON-P），可以在pom.xml中添加相应依赖：

<!-- Jackson（默认包含） -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 如果需要Gson -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.9</version>
</dependency>

接收JSON数据

1 使用@RequestBody注解

当客户端向服务器发送JSON数据时，可以使用@RequestBody注解将请求体中的JSON数据绑定到方法参数上：

@PostMapping("/users")
public ResponseEntity<User> createUser(@RequestBody User user) {
    // 处理接收到的user对象
    return ResponseEntity.ok(user);
}

2 自定义JSON反序列化

如果需要自定义JSON到对象的转换过程，可以实现JsonDeserializer接口：

public class CustomDateDeserializer extends JsonDeserializer<Date> {
    @Override
    public Date deserialize(JsonParser p, DeserializationContext ctxt) 
      throws IOException, JsonProcessingException {
        return new SimpleDateFormat("yyyy-MM-dd").parse(p.getValueAsString());
    }
}

然后在实体类上使用@JsonDeserialize注解：

public class User {
    @JsonDeserialize(using = CustomDateDeserializer.class)
    private Date birthDate;
    // 其他字段...
}

3 处理JSON数组

接收JSON数组时，可以使用List<T>作为参数类型：

@PostMapping("/users/batch")
public ResponseEntity<List<User>> createUsers(@RequestBody List<User> users) {
    // 处理用户列表
    return ResponseEntity.ok(users);
}

发送JSON数据

1 使用@ResponseBody注解

控制器方法可以直接返回对象,Spring会自动将其序列化为JSON：

@GetMapping("/users/{id}")
public @ResponseBody User getUser(@PathVariable Long id) {
    // 从数据库获取用户
    return userRepository.findById(id).orElse(null);
}

或者使用更简洁的@RestController：

@RestController
@RequestMapping("/api")
public class UserController {
    @GetMapping("/users/{id}")
    public User getUser(@PathVariable Long id) {
        return userRepository.findById(id).orElse(null);
    }
}

2 自定义JSON序列化

同样可以实现JsonSerializer接口来自定义序列化过程：

public class CustomDateSerializer extends JsonSerializer<Date> {
    @Override
    public void serialize(Date date, JsonGenerator gen, SerializerProvider provider) 
      throws IOException {
        gen.writeString(new SimpleDateFormat("yyyy-MM-dd").format(date));
    }
}

然后在实体类上使用@JsonSerialize注解：

public class User {
    @JsonSerialize(using = CustomDateSerializer.class)
    private Date birthDate;
    // 其他字段...
}

3 统一响应格式

为了保持API响应的一致性,可以创建统一的响应包装类：

public class ApiResponse<T> {
    private int status;
    private String message;
    private T data;
    // 构造方法、getter和setter
}

然后在控制器中使用：

@GetMapping("/users/{id}")
public ApiResponse<User> getUser(@PathVariable Long id) {
    User user = userRepository.findById(id).orElse(null);
    return new ApiResponse<>(200, "Success", user);
}

高级配置

1 配置ObjectMapper

可以通过配置ObjectMapper来定制JSON处理行为：

@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        // 禁止将日期序列化为时间戳
        mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
        // 注册自定义模块
        mapper.registerModule(new JavaTimeModule());
        return mapper;
    }
}

2 全局异常处理

使用@ControllerAdvice和@ExceptionHandler可以统一处理JSON解析异常：

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public ResponseEntity<ApiResponse<String>> handleJsonParseException(
            HttpMessageNotReadableException ex) {
        return ResponseEntity.badRequest()
               .body(new ApiResponse<>(400, "Invalid JSON format", null));
    }
}

实战示例

下面是一个完整的用户管理API示例,展示了JSON数据的收发：

@RestController
@RequestMapping("/api/users")
public class UserController {
    @Autowired
    private UserRepository userRepository;
    @PostMapping
    public ApiResponse<User> createUser(@Valid @RequestBody User user) {
        // @Valid会触发JSR-303验证
        User savedUser = userRepository.save(user);
        return new ApiResponse<>(201, "User created", savedUser);
    }
    @GetMapping("/{id}")
    public ApiResponse<User> getUser(@PathVariable Long id) {
        return userRepository.findById(id)
               .map(user -> new ApiResponse<>(200, "Success", user))
               .orElse(new ApiResponse<>(404, "User not found", null));
    }
    @PutMapping("/{id}")
    public ApiResponse<User> updateUser(
            @PathVariable Long id, 
            @Valid @RequestBody User userDetails) {
        return userRepository.findById(id)
               .map(user -> {
                   user.setName(userDetails.getName());
                   user.setEmail(userDetails.getEmail());
                   User updatedUser = userRepository.save(user);
                   return new ApiResponse<>(200, "User updated", updatedUser);
               })
               .orElse(new ApiResponse<>(404, "User not found", null));
    }
    @DeleteMapping("/{id}")
    public ApiResponse<Void> deleteUser(@PathVariable Long id) {
        if (userRepository.existsById(id)) {
            userRepository.deleteById(id);
            return new ApiResponse<>(204, "User deleted", null);
        }
        return new ApiResponse<>(404, "User not found", null);
    }
}

性能优化建议

1. 重用ObjectMapper实例：避免为每个请求创建新的ObjectMapper,使用单例实例。
2. 选择合适的JSON库：根据项目需求选择Jackson、Gson或Fastjson等库。
3. 避免不必要的序列化：使用@JsonIgnore或@JsonIgnoreProperties排除不需要序列化的字段。
4. 使用DTO模式：为API创建专门的DTO类,避免直接暴露实体类。

Spring框架提供了强大而灵活的JSON处理能力，从简单的@RequestBody和@ResponseBody注解，到高级的自定义序列化和反序列化配置，可以满足各种复杂场景的需求，通过合理配置和最佳实践的应用，可以构建出高效、健壮的RESTful API，随着Spring Boot的不断发展，JSON处理功能也在不断完善,开发者应持续关注新版本带来的特性和改进。