fastjson详解@JSONField注解的使用、字段转换

一、什么是fastjson
fastjson是阿里巴巴的开源JSON解析库，它可以解析JSON格式的字符串，支持将Java Bean序列化为JSON字符串，也可以从JSON字符串反序列化到JavaBean。

二、fastjson的优点

2.1 速度快
fastjson相对其他JSON库的特点是快，从2011年fastjson发布1.1.x版本之后，其性能从未被其他Java实现的JSON库超越。

2.2 使用广泛
fastjson在阿里巴巴大规模使用，在数万台服务器上部署，fastjson在业界被广泛接受。在2012年被开源中国评选为最受欢迎的国产开源软件之一。

2.3 测试完备
fastjson有非常多的testcase，在1.2.11版本中，testcase超过3321个。每次发布都会进行回归测试，保证质量稳定。

2.4 使用简单
fastjson的API十分简洁。

String text = JSON.toJSONString(obj); //序列化
VO vo = JSON.parseObject("{...}", VO.class); //反序列化

2.5 功能完备

支持泛型，支持流处理超大文本，支持枚举，支持序列化和反序列化扩展。

三、下载和使用
你可以在maven中央仓库中直接下载：fastjson依赖

或者配置maven依赖

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>x.x.x</version>
</dependency>

其中x.x.x是版本号，跟进需要使用特定版本，建议使用最新版本。
FastJson中 的注解@JSONField，一般作用在get/set方法上面，常用的使用场景有下面三个：

1. 修改和json字符串的字段映射【name】
2. 格式化数据【format】
3. 过滤掉不需要序列化的字段【serialize】
   通过用@JSONField注解一个类的属性，我们可以达到以下目标

@JSONField(name = “n1”) — 指定field对应的key名称

@JSONField(format = “yyyy-MM-dd HH:mm:ss”) — 对于时间字段，指定其格式

@JSONField(serialize = false) — 不序列化某些字段

@JSONField(ordinal = 1) — 指定顺序

代码示例：

1.修改字段映射使用方法：

　　private Integer aid;
　　// 实体类序列化为json字符串的时候，此类的aid字段，序列化为json中的testid字段
　　@JSONField(name="testid") 
　　public Integer getAid() {
　　    return aid;
　　}
 
　　// json字符串解析为类实体的时候，json中的id字段，写入此类的aid字段
　　@JSONField(name="id")
　　public void setAid(Integer aid) {
　　    this.aid = aid;
　　}

2.格式化使用方法

　　@JSONField(format = "yyyy-MM-dd HH:mm:ss")
　　public Date getDateCompleted(...)

3.过滤不需要序列化的字段

　　@JSONField(serialize = false)
　　public Integer getProgress() {
    　　return progress;
　　}

public class Order{
    /**
     * 主键id
     */
    @JSONField(serialize = false)
    long id;
 
    /**
     * 订单编码
     */
    String code;
 
    /**
     * 订单标题
     */
    String title;
 
    /**
     * 订单价格
     */
    double price;
 
    /**
     * 订单类型
     */
    @JSONField(name = "order_type")
    int orderType;
 
    /**
     * 订单创建时间
     */
    @JSONField(format = "yyyy-MM-dd HH:mm:ss")
    Date ctime;
 
    /**
     * 订单支付时间
     */
    @JSONField(name = "pay_time", format = "yyyy-MM-dd HH:mm")
    Date payTime;
}

@Data
@TableName("tb_user")
public class UserEntity implements Serializable {
   private static final long serialVersionUID = 1L;

   /**
    * 用户ID
    */
   @TableId
   private Long id;
   /**
    * 用户名
    */
   private String username;
   /**
    * 手机号
    */
   private String mobile;
   /**
    * 密码
    */
   @JSONField(serialize=false)
   private String password;
   /**
    * 创建时间
    */
   private Date createDate;

}