目錄
一、使用場景
二、環(huán)境準備
1、引入依賴
2、實體類
三、示例
1、不返回空值
(1)方式
(2)測試
(3)說明
2、不返回部分屬性
(1)方式
(2)測試
四、?Jackson常用注解
1、 @JsonProperty
2、@JsonPropertyOrder
3、@JsonInclude
4、@JsonIgnoreProperties
5、@JsonFormat
6、@JsonUnwrapped
一、使用場景
????????在開發(fā)過程中，有時候需要將后端數(shù)據(jù)返回前端，此時有些數(shù)據(jù)為空屬性不需要返回，或者有些屬性不需要返回，因此就需要處理。
二、環(huán)境準備
1、引入依賴
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.10.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.10.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.10.0</version>
</dependency>
2、實體類
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Student{
private Integer id;
private String name;
private Integer age;
private String address;
private BigDecimal score;
private String className;
private List<String> subjectList = new ArrayList<>();
}
三、示例
1、不返回空值
(1)方式
在實體類上面加上下面的注解：
@JsonInclude(JsonInclude.Include.NON_EMPTY)?
(2)測試
Controller里面的方法：
@PostMapping("/getData")
public R getData(){
Student student = new Student();
student.setName("Tom");
student.setAge(22);
return R.ok().data("student", student);
}測試結(jié)果：
(3)說明
如果要對部分屬性進行空值限制，分為兩類：
- 字符串、基本數(shù)據(jù)類型的設(shè)置，使用JsonInclude.Include.NON_NULL
- 對象、數(shù)組之類的設(shè)置，使用JsonInclude.Include.NON_EMPTY
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Student{
@JsonInclude(JsonInclude.Include.NON_NULL)
private Integer id;
@JsonInclude(JsonInclude.Include.NON_NULL)
private String name;
@JsonInclude(JsonInclude.Include.NON_NULL)
private Integer age;
@JsonInclude(JsonInclude.Include.NON_NULL)
private String address;
@JsonInclude(JsonInclude.Include.NON_NULL)
private BigDecimal score;
@JsonInclude(JsonInclude.Include.NON_NULL)
private String className;
@JsonInclude(JsonInclude.Include.NON_EMPTY)
private List<String> subjectList = new ArrayList<>();
}
2、不返回部分屬性
(1)方式
實體類屬性上使用注解：
@JsonIgnore
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
@Data
@NoArgsConstructor
@AllArgsConstructor
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class Student {
private Integer id;
private String name;
private Integer age;
@JsonIgnore
private String address;
private BigDecimal score;
private String className;
private List<String> subjectList = new ArrayList<>();
}
(2)測試
Controller里面的方法：
@PostMapping("/getData")
public R getData(){
Student student = new Student();
student.setId(1001);
student.setName("Tom");
student.setAge(22);
student.setAddress("浙江");
return R.ok().data("student", student);
}測試結(jié)果：
四、?Jackson常用注解
1、 @JsonProperty
????????此注解用于屬性上，作用是把該屬性的名稱序列化為另外一個名稱，如把testPwd屬性序列化為pwd，@JsonProperty(value="pwd")。
2、@JsonPropertyOrder
????????作用在類上，被用來指明當序列化時需要對屬性做排序，它有2個屬性一個是alphabetic：布爾類型，表示是否采用字母拼音順序排序，默認是為false，即不排序。如@JsonPropertyOrder(alphabetic=true)。
3、@JsonInclude
????????是用在實體類的方法類的頭上 作用是實體類的參數(shù)查詢到的為null的不顯示，比如說你想傳一些json數(shù)據(jù)到前臺，但是不想傳值為null的數(shù)據(jù)，就可以使用該標簽。如@JsonInclude(JsonInclude.Include.NON_NULL)
4、@JsonIgnoreProperties
????????可以注明是想要忽略的屬性列表如@JsonIgnoreProperties({"name","age","title"})，也可以注明過濾掉未知的屬性如@JsonIgnoreProperties(ignoreUnknown=true),@JsonIgnore表示忽略當前屬性。
5、@JsonFormat
????????用在屬性和方法上，可以方便的進行格式轉(zhuǎn)換，如把Date轉(zhuǎn)換為我們要的模式@JsonFormat(pattern = "yyyy-MM-dd HH-mm-ss")。文章來源：http://www.zghlxwxcb.cn/news/detail-764523.html
6、@JsonUnwrapped
????????當實體類中成員屬性是一個類的對象時候，忽略包裝。直接顯示屬性。文章來源地址http://www.zghlxwxcb.cn/news/detail-764523.html
到了這里，關(guān)于java后端返回數(shù)據(jù)給前端時去除值為空或NULL的屬性、忽略某些屬性的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
