Gson使用的一些小技巧（忽略某些字段、统一处理某种类型的数据等）

缺乏、安全感 2022-11-04 11:24 33阅读 0赞

在Android/Java开发过程中，我们肯定会涉及到处理Josn，我个人比较常用的json处理第三方库是Gson，下面是开发过程中遇到的一些需求的解决方式，仅供参考。

--------------------

## Gson实体类转Json时（Gson反序列化实体类数据时），忽略掉某些字段 ##

例如：  
我有一个实体类如下：

data class Data(
        val id: Long,
        val goodsName: String,
        var price: BigDecimal,
    
        var enabled: Boolean,
        val createBy: String,
        var modifyBy: String,
    
        )

正常情况下我们是这样把实体类转成json

val gson = GsonBuilder().create()
    	val testData = Data(id = 1, goodsName = "笔记本", price = BigDecimal.valueOf(6999),true,"yuzhiqiang","yuzhiqiang")
        val jsonStr = gson.toJson(testData)
        println("序列化后的数据：${
          jsonStr}")

打印如下：

序列化后的数据：{
        "id":1,"goodsName":"笔记本","price":6999,"enabled":true,"createBy":"yuzhiqiang","modifyBy":"yuzhiqiang"}

假如这个是后台要返回给前端的数据，前端是不需要 createBy 和 modifyBy 这两个字段的，那么我们可以使用  
**excludeFieldsWithoutExposeAnnotation**  
来实现，该方法会将Gson配置为在序列化或反序列化时 **排除** 所有 **没有被 Expose 注解** 的字段。

注意： 是没有Expose注解的字段会被Gson给排除掉

我们先来看下**Expose**注解  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1emhpcWlhbmdfMTk5Mw_size_16_color_FFFFFF_t_70]  
这个注解有两个配置，分别是序列化和反序列化，默认值为true，也就是默认序列化和反序列化都处理。

下面我们来用一下：  
例如我们想忽略掉 createBy 和 modifyBy 字段，那么我们给不希望被忽略的字段加上 `@Expose` 注解即可。不想做处理的字段不加`@Expose` 注解。

data class Data(
        @Expose
        val id: Long,
        @Expose
        val goodsName: String,
        @Expose
        var price: BigDecimal,
        @Expose
        var enabled: Boolean,
        
        val createBy: String,
        var modifyBy: String,
    
        )

此时创建Gson时要注意调用一下 `excludeFieldsWithoutExposeAnnotation` 方法。

val gson = GsonBuilder().excludeFieldsWithoutExposeAnnotation().create()
        val testData = Data(id = 1, goodsName = "笔记本", price = BigDecimal.valueOf(6999),true,"yuzhiqiang","yuzhiqiang")
        val jsonStr = gson.toJson(testData)
        println("序列化后的数据：${
          jsonStr}")

看下打印的log：

序列化后的数据：{
        "id":1,"goodsName":"笔记本","price":6999,"enabled":true}

可以看到 createBy 和 modifyBy 两个字段就没有了。

我们也可以手动去配置某个字段在序列化或反序列化时是否会被忽略掉。  
例如

val gson = GsonBuilder().excludeFieldsWithoutExposeAnnotation().create()
    
        val testJson = "{\n" +
                "  \"id\": 1,\n" +
                "  \"createBy\": \"yzq\",\n" +
                "  \"modifyBy\": \"xeon\",\n" +
                "  \"price\": 99.99999,\n" +
                "  \"enabled\": true\n" +
                "}"
    
        val serializationData = gson.fromJson(testJson, Data::class.java)
        println("反序列化的数据：${
          serializationData}")
        val testData = Data(id = 1, goodsName = "笔记本", price = BigDecimal.valueOf(6999),true,"yuzhiqiang","yuzhiqiang")
        val jsonStr = gson.toJson(testData)
        println("序列化后的数据：${
          jsonStr}")

打印如下：

反序列化的数据：Data(id=0, goodsName=null, price=99.99999, enabled=false, createBy=null, modifyBy=null)
    序列化后的数据：{
        "id":1,"goodsName":"笔记本","price":6999}

--------------------

## 针对某一种类型的数据统一处理（JsonSerializer，JsonDeserializer） ##

应用场景：  
对于金额来讲，我们都是用 BigDecimal 类型的，假如有个这种需求，后台数据库中关于金额的数据都是保留小数点后4位的，但是Android端显示的时候只要显示小数点后两位。

那我们就有两种处理方式。  
一种是在服务端处理，服务端返回Json数据的时候针对金额的数据处理一下，只返回小数点就两位的值。  
另一种是在Android处理，不管服务端怎么返回，Android端在解析Json数据时对金额字段的值做一个处理，只取小数点后两位的值。

首先，不管在哪一边处理，一个一个的去处理字段是最蠢最麻烦的办法，肯定不推荐。  
我们可以通过自定义**JsonSerializer**或**JsonDeserializer** 统一处理

方案如下

在服务端处理，我们可以自定义一个序列化的接口，如下

import com.google.gson.JsonElement
    import com.google.gson.JsonPrimitive
    import com.google.gson.JsonSerializationContext
    import com.google.gson.JsonSerializer
    import java.lang.reflect.Type
    import java.math.BigDecimal
    
    
    /**
     * @description: 实体类转json（序列化）时对BigDecimal类型的值的处理
     * @author : yuzhiqiang (zhiqiang.yu.xeon@gmail.com)
     * @date   : 2021/3/6
     * @time   : 16:53
     */
    class BigDecimalSerializer : JsonSerializer<BigDecimal> {
        
        override fun serialize(src: BigDecimal, typeOfSrc: Type?, context: JsonSerializationContext?): JsonElement {
        
    
            /*四舍五入*/
            val newVal = src.setScale(2, BigDecimal.ROUND_HALF_UP)
            /*返回Josnelement*/
            return JsonPrimitive(newVal)
    
        }
    }

用法（注意创建gson的时候要调用registerTypeAdapter）：

val gson = GsonBuilder().excludeFieldsWithoutExposeAnnotation()
            .registerTypeAdapter(BigDecimal::class.java,BigDecimalSerializer())
            .create()
    
        val testData =
            Data(id = 1, goodsName = "笔记本", price = BigDecimal.valueOf(6999.1123), true, "yuzhiqiang", "yuzhiqiang")
        val jsonStr = gson.toJson(testData)
        println("序列化后的数据：${
          jsonStr}")

打印如下：

序列化后的数据：{
        "id":1,"goodsName":"笔记本","price":6999.11}

在Android端处理，自定义一个反序列化接口，代码如下

import com.google.gson.JsonDeserializationContext
    import com.google.gson.JsonDeserializer
    import com.google.gson.JsonElement
    import java.lang.reflect.Type
    import java.math.BigDecimal
    import java.math.RoundingMode
    
    
    /**
     * @description: json转实体类(反序列化)时对BigDecimal类型的值的处理
     * @author : yuzhiqiang (zhiqiang.yu.xeon@gmail.com)
     * @date   : 2021/3/6
     * @time   : 17:19
     */
    
    class BigDecimalDeSerializer : JsonDeserializer<BigDecimal> {
        
    
        override fun deserialize(json: JsonElement, typeOfT: Type?, context: JsonDeserializationContext?): BigDecimal {
        
            /*四舍五入*/
            val newValue = json.asBigDecimal.setScale(2, RoundingMode.HALF_UP)
            /*返回处理后的值*/
            return newValue
        }
    }

使用方法类似：

val gson = GsonBuilder().excludeFieldsWithoutExposeAnnotation()
            .registerTypeAdapter(BigDecimal::class.java, BigDecimalDeSerializer())
            .create()
    
        val testJson = "{\n" +
                "  \"id\": 1,\n" +
                "  \"createBy\": \"yzq\",\n" +
                "  \"modifyBy\": \"xeon\",\n" +
                "  \"price\": 99.2923,\n" +
                "  \"enabled\": true\n" +
                "}"
    
        val serializationData = gson.fromJson(testJson, Data::class.java)
        println("反序列化的数据：${
          serializationData}")

打印如下：

反序列化的数据：Data(id=0, goodsName=null, price=99.29, enabled=false, createBy=null, modifyBy=null)

--------------------

## Gson直接将json转list以及可能可能遇到com.google.gson.internal.LinkedTreeMap cannot be cast to xxx 的坑 ##

如果你需要直接将json数组转成list以及在转换后遇到类似

com.google.gson.internal.LinkedTreeMap cannot be cast to xxx

这样的报错，可以参考下面这篇文章

[Gson直接将json转list示例 (TypeToken)以及通过内联函数结合reified简化代码][Gson_json_list_ _TypeToken_reified]

--------------------

暂时就这些，后续有其他小技巧会补充，也欢迎大家提出需求以及自己常用的小技巧，谢谢！

--------------------

**如果你觉得本文对你有帮助，麻烦动动手指顶一下，可以帮助到更多的开发者，如果文中有什么错误的地方，还望指正，转载请注明转自[喻志强的博客][Link 1] ，谢谢！**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1emhpcWlhbmdfMTk5Mw_size_16_color_FFFFFF_t_70]: /images/20221023/96207165409a45d6b67ac8a8afcc80b9.png
[Gson_json_list_ _TypeToken_reified]: https://blog.csdn.net/yuzhiqiang_1993/article/details/85697698?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522161501897716780264096892%2522%252C%2522scm%2522%253A%252220140713.130102334.pc%255Fblog.%2522%257D&request_id=161501897716780264096892&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2~blog~first_rank_v2~rank_v29-1-85697698.pc_v2_rank_blog_default&utm_term=json%20%E8%BD%AC%20list
[Link 1]: https://yuzhiqiang.blog.csdn.net/