jackson对于默认值不进行序列化

场景

json串中的属性值有些是默认的，那么就不必要传递给服务端了，减少对象序列化为json的时间。

json与对象的转换自然要借助于json工具了，也是我们今天的猪脚：jackson。

gradle配置

dependencies {
compile ‘com.fasterxml.jackson.core:jackson-databind:2.3.1’
}

因为jackson中含有挺多包的，可能造成文件的重复，这样子在打包的时候会提示出错，所以需要在gradle添加以下配置：

packagingOptions {
exclude ‘META-INF/LICENSE’
exclude ‘META-INF/NOTICE’
}

代码分析
我们创建了两个实体类：ResultData和UserModel

/**
 * Created by cjy on 2018/4/10 0010.
 */

public class ResultData {
    public int code;
    public String msg;
    public UserModel data;

    public ResultData() {
    }

    public ResultData(String msg, UserModel data) {
        this.msg = msg;
        this.data = data;
    }
}

/**
 * Created by cjy on 2018/4/10 0010.
 */

public class UserModel {
    public String name;
    public List<String> tags;

    public UserModel() {
    }

    public UserModel(String name, List<String> tags) {
        this.name = name;
        this.tags = tags;
    }
}

在MainActivity，我们进行测试：对于默认值不进行序列化。在这里延伸一二，顺便测试了下对于NULL和空字符串的处理。

package com.example.cjy.jsonnotdealdefaultvalue;

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.util.ArrayList;
import java.util.List;

public class MainActivity extends AppCompatActivity implements View.OnClickListener {
    private TextView mTvText;
    private TextView mTvJsonText;
    private Button mBtnDefaultJson;
    private Button mBtnNullJson;
    private Button mBtnEmptyJson;

    private String initJsonStr = "{\n" +
            "\t\"code\": 0,\n" +
            "\t\"msg\": \"消息不为空，code为默认值，data的name属性为空字符串，tags数组为[你好,null]\",\n" +
            "\t\"data\": {\n" +
            "\t\t\"name\": \"\",\n" +
            "\t\t\"tags\": [\"你好\", null]\n" +
            "\t}\n" +
            "}";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mTvText = findViewById(R.id.tv_text);
        mTvJsonText = findViewById(R.id.tv_json_text);
        mBtnDefaultJson = findViewById(R.id.btnDefaultJson);
        mBtnNullJson = findViewById(R.id.btnNullJson);
        mBtnEmptyJson = findViewById(R.id.btnEmptyJson);

        mTvText.setText("对象的原始json："+initJsonStr);
        Log.e("原始对象的json：",initJsonStr);

        mBtnDefaultJson.setOnClickListener(this);
        mBtnNullJson.setOnClickListener(this);
        mBtnEmptyJson.setOnClickListener(this);
    }

    private String outJson(JsonInclude.Include type){
        ObjectMapper mapper = new ObjectMapper();
        mapper.setSerializationInclusion(type);

        //通过该方法对mapper对象进行设置，所有序列化的对象都将按改规则进行系列化
        //Include.Include.ALWAYS 默认
        //Include.NON_DEFAULT 属性为默认值不序列化
        //Include.NON_EMPTY 属性为 空（“”） 或者为 NULL 都不序列化
        //Include.NON_NULL 属性为NULL 不序列化

        //对于List Map不适用
        List<String> tags = new ArrayList<>();
        tags.add("你好");
        tags.add(null);

        ResultData data = new ResultData("消息不为空，code为默认值，data的name属性为空字符串，tags数组为null",new UserModel("",tags));
        String outJson = null;
        try {
            outJson = mapper.writeValueAsString(data);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
            outJson = "";
        }
        return outJson;


    }

    @Override
    public void onClick(View view) {
        int id = view.getId();
        String json = "";
        switch (id){
            case R.id.btnDefaultJson:{
                json = outJson(JsonInclude.Include.NON_DEFAULT);
                break;
            }
            case R.id.btnNullJson:{
                json = outJson(JsonInclude.Include.NON_NULL);
                break;
            }
            case R.id.btnEmptyJson:{
                json = outJson(JsonInclude.Include.NON_EMPTY);
                break;
            }
        }
        mTvJsonText.setText("转换成json："+json);

    }
}

第一种情况：对于默认值不进行序列化

第二种情况：对于空字符串或NULL不进行序列化

对于jackson有兴趣的同学，可以看看该文：Jackson框架的高阶应用