Spring Boot返回JSON 數(shù)據(jù)的案例

小編給大家分享一下Spring Boot返回JSON 數(shù)據(jù)的案例，希望大家閱讀完這篇文章后大所收獲，下面讓我們一起去探討吧！

在 WEB 項目中返回 JSON 數(shù)據(jù)是常見的交互形式，在 Spring Boot 中這一切都變得十分簡單。So easy!!!

如何返回 JSON 數(shù)據(jù)？

在 Spring Boot 中返回 JSON 數(shù)據(jù)很簡單，如下幾步。

加入依賴

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.4.RELEASE</version>
</parent>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

除了 Spring Boot 必須自帶的 parent 依賴外，僅僅只需要加入這個 spring-boot-starter-web 包即可，它會自動包含所有 JSON 處理的包，如下圖所示。

返回 XML 數(shù)據(jù)格式定義

1）定義返回方式

在 Controller 類上面用 @RestController 定義或者在方法上面用 @ResponseBody 定義，表明是在 Body 區(qū)域輸出數(shù)據(jù)。

下面是使用示例：

@RestController
public class JsonTest {

    @GetMapping(value = "/user/{userId}")
    public User getUserInfo(@PathVariable("userId") String userId) {
        User user = new User("Java技術(shù)棧", 18);
        user.setId(Long.valueOf(userId));
        return user;
    }

}

2）自定義輸出格式

上面的方法直接返回對象，對象會自動轉(zhuǎn)換為 XML 格式，不過是默認的標(biāo)簽，可以通過以下標(biāo)簽進行自定義 XML 格式。

public class User {

    @JsonProperty("user-name")
    private String userName;

    private Long id;

    private Integer age;

    @JsonIgnore
    private String address;

    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String memo;
    
    // get set 略
    
}

程序輸出：

{"id":1,"age":18,"user-name":"Java技術(shù)棧"}

上面演示了幾個常用的注解。

@JsonProperty： 可用來自定義屬性標(biāo)簽名稱；

@JsonIgnore： 可用來忽略不想輸出某個屬性的標(biāo)簽；

@JsonInclude： 可用來動態(tài)包含屬性的標(biāo)簽，如可以不包含為 null 值的屬性；

更多注解可以查看這個包：

如何手動完成對象 和 Json 的互轉(zhuǎn)？

jackson-databind 包里面有一個 com.fasterxml.jackson.databind.ObjectMapper 類可以完成對象和 Json 數(shù)據(jù)的互轉(zhuǎn)，下面是一個簡單的合作示例。

ObjectMapper objectMapper = new ObjectMapper();

String userJsonStr = objectMapper.writeValueAsString(user);

User jsonUser = objectMapper.readValue(userJsonStr, User.class);

看完了這篇文章，相信你對Spring Boot返回JSON 數(shù)據(jù)的案例有了一定的了解，想了解更多相關(guān)知識，歡迎關(guān)注億速云行業(yè)資訊頻道，感謝各位的閱讀！