springboot怎么渲染json

Spring Boot渲染JSON的多种方式与最佳实践**

在现代Web开发中,JSON（JavaScript Object Notation）已成为前后端数据交换的主流格式，Spring Boot作为Java生态中最流行的框架之一，对JSON的支持非常完善且便捷，本文将详细介绍Spring Boot中渲染JSON的多种方式，从基础的自动配置到高级的自定义配置，帮助开发者这一核心技能。

Spring Boot的JSON自动配置：开箱即用

Spring Boot的魔力很大程度上体现在其“约定优于配置”和强大的自动配置（Auto-configuration）能力，在JSON渲染方面，Spring Boot通过引入spring-boot-starter-web依赖，已经为我们做好了大部分工作。

核心依赖：当你创建Spring Boot项目并选择spring-boot-starter-web时，它会自动引入以下与JSON处理密切相关的依赖（具体版本取决于Spring Boot版本）：
- jackson-databind：Jackson库的核心，用于在Java对象和JSON数据之间进行序列化和反序列化。
- jackson-core：Jackson的核心API。
- jackson-annotations：Jackson的注解支持。 Jackson是目前Spring Boot默认的JSON处理库。
默认行为： Spring Boot的Web自动配置会：
- 自动注册一个ObjectMapper实例，这是Jackson库的核心对象，负责JSON的读写。
- 配置好消息转换器（HttpMessageConverter），特别是MappingJackson2HttpMessageConverter，它负责将控制器返回的Java对象转换为JSON响应体，并将请求体中的JSON数据转换为Java对象。

最简单的JSON渲染：返回POJO对象

在Spring Boot中，最常见、最简单的JSON渲染方式就是直接在Controller的方法中返回一个普通的Java对象（POJO - Plain Old Java Object），Spring Boot会自动使用ObjectMapper将该对象序列化为JSON格式的响应。

示例步骤：

创建POJO类：

public class User {
    private Long id;
    private String name;
    private Integer age;
    // 构造方法、getter和setter省略
    // 为了方便测试，可以重写toString方法
}

创建Controller并返回该POJO：

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("/{id}")
    public User getUserById(@PathVariable Long id) {
        // 模拟从数据库或其他服务获取数据
        User user = new User();
        user.setId(id);
        user.setName("张三");
        user.setAge(30);
        return user; // 直接返回User对象
    }
}

测试：启动应用，访问http://localhost:8080/api/users/1，你将得到类似如下的JSON响应：
```
{
    "id": 1,
    "name": "张三",
    "age": 30
}
```
@RestController注解本身已经包含了@ResponseBody，表示方法的返回值直接作为响应体，而不是视图名称。

返回Map或List集合

除了返回自定义的POJO,Spring Boot也支持直接返回Map或List等集合类型，它们同样会被自动转换为JSON。

示例：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@RestController
@RequestMapping("/api/data")
public class DataController {
    @GetMapping("/map")
    public Map<String, Object> getMapData() {
        Map<String, Object> map = new HashMap<>();
        map.put("code", 200);
        map.put("message", "成功");
        map.put("data", Arrays.asList("苹果", "香蕉", "橙子"));
        return map;
    }
    @GetMapping("/list")
    public List<User> getListData() {
        User user1 = new User(1L, "李四", 25);
        User user2 = new User(2L, "王五", 28);
        return Arrays.asList(user1, user2);
    }
}

访问对应接口,你会得到JSON格式的Map或List数据。

使用`@ResponseBody`注解（与`@RestController`的区别）

如果你使用的是@Controller注解来标记控制器类，那么方法返回的默认是视图名称，如果希望该方法返回JSON数据，就需要在方法上添加@ResponseBody注解。

@ResponseBody表示方法的返回值直接写入HTTP响应体中，通常用于返回JSON、XML等数据。

示例：

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
@RequestMapping("/api/legacy")
public class LegacyController {
    @GetMapping("/user")
    @ResponseBody // 明确表示返回JSON，不进行视图解析
    public User getUser() {
        return new User(3L, "赵六", 35);
    }
}

@RestController等同于@Controller + @ResponseBody的组合，所以推荐在RESTful API开发中使用@RestController。

自定义JSON序列化与反序列化

在实际开发中,我们可能需要对JSON的格式进行自定义控制，

忽略某些字段
自定义字段名称
格式化日期
处理循环引用

Jackson提供了丰富的注解来实现这些需求。

常用Jackson注解：

@JsonIgnore：用于标记在序列化或反序列化时忽略该字段。
@JsonProperty：用于指定JSON字段与Java字段的映射关系，可以自定义JSON字段名。
@JsonFormat：用于格式化日期、数字等类型，如日期格式化。
@JsonInclude：用于控制哪些属性应该被包含在JSON输出中（非空值、非空字段等）。

示例：

import com.fasterxml.jackson.annotation.*;
import java.util.Date;
@JsonInclude(JsonInclude.Include.NON_NULL) // 只包含非空字段
public class Product {
    private Long id;
    @JsonProperty("product_name") // 自定义JSON字段名
    private String name;
    @JsonIgnore // 忽略该字段，不参与JSON序列化/反序列化
    private String internalCode;
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8") // 日期格式化
    private Date createTime;
    // 构造方法、getter和setter省略
}

全局配置`ObjectMapper`

如果需要对JSON进行全局性的配置,可以通过配置自定义的ObjectMapper Bean来实现。

示例：

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder) {
        ObjectMapper objectMapper = builder.createXmlMapper(false).build();
        // 可以在这里进行自定义配置
        // 设置日期格式
        // objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd"));
        // 或者处理循环引用
        // objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        return objectMapper;
    }
}

或者,通过application.properties或application.yml进行一些简单配置：

application.properties示例：

# 美化JSON输出
spring.jackson.serialization.indent_output=true
# 日期格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
# 时区
spring.jackson.time-zone=GMT+8
# 忽略未知属性
spring.jackson.deserialization.fail-on-unknown-properties=false

使用其他JSON库

虽然Jackson是Spring Boot的默认选择，但如果你更喜欢使用Gson或JSON-P/JSON-B，也可以进行替换。

移除Jackson依赖（如果项目中有）。

添加所需JSON库的依赖，例如Gson：

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
</dependency>

配置HttpMessageConverter： Spring Boot会检测到Gson的存在并自动配置GsonHttpMessageConverter，如果你需要完全控制，可以手动配置。

但通常情况下,Jackson已经足够强大且高效，除非有特殊需求，否则不建议更换。

Spring Boot渲染JSON的方式灵活多样，从最简单的返回POJO对象，到使用Jackson注解进行精细化控制，再到全局配置ObjectMapper，都能满足不同场景的需求。

对于大多数场景，直接返回POJO对象是最简单高效的方式。
当需要对JSON格式进行特殊处理时，Jackson注解是你的得力助手。
**全局配置

企鹅直播企鹅直播足球直播爱奇艺直播爱奇艺足球直播足球直播足球直播

正文

springboot怎么渲染json

Spring Boot的JSON自动配置：开箱即用

最简单的JSON渲染：返回POJO对象

返回Map或List集合

使用`@ResponseBody`注解（与`@RestController`的区别）

自定义JSON序列化与反序列化

全局配置`ObjectMapper`

使用其他JSON库

相关阅读

json如何转义字符

json数据过大怎么分割

手机如何保存JSON文件

js中json有什么方法吗

发表评论取消回复

还没有评论，来说两句吧...

目录[+]

Spring Boot的JSON自动配置：开箱即用

最简单的JSON渲染：返回POJO对象

返回Map或List集合

使用@ResponseBody注解（与@RestController的区别）

自定义JSON序列化与反序列化

全局配置ObjectMapper

使用其他JSON库

相关阅读

json如何转义字符

json数据过大怎么分割

手机如何保存JSON文件

js中json有什么方法吗

发表评论取消回复

还没有评论，来说两句吧...

目录[+]

使用`@ResponseBody`注解（与`@RestController`的区别）

全局配置`ObjectMapper`