运行时解析json生成class的json-class-generator

JCG(json-class-generator)¹是一个可用于运行时根据json生成class的工具，可能使用场景不多。由于是运行时生成的class，所以生成的class也只能通过反射去使用。

技术栈

gson：json解析工具；
asm：字节码生成工具；

特性

将json解析生成class，为class添加字段和对应字段的get、set方法；
支持为生成的class添加注解，使用注解规则声明将注解添加在类或是字段上；

基础功能：将json解析生成class

为验证结果的正确性，可配置将本工具包生成的class输出到文件，通过idea打开可以查看生成的java代码。

public class JsonToClassTest {

    static {
        // value为输出的目录
        System.setProperty("jcg.classSavaPath", "/Users/wjy/MyProjects/JsonClassGenerator");
    }
}

默认情况下，当JSON有字段为null时则会解析失败，如果这些字段不是必须的，那么我们可以通过以下配置让JCG忽略这些字段：

public class JsonToClassTest {

    static {
         /**
          * 是否忽略空字段，默认为false
          */
        System.setProperty("jcg.ignore_null_field", "true");
    }
}

既然要用到动态json解析生成class，那么说明json我们是通过API或者读取数据库获取的。为了简单，我们就直接定义json字符串来测试了。

假设json为：

{
  "name":"name",
  "price":1.0,
  "nodes":[
     {
      "id":222,
      "note":"xxx"
     }
  ]
}

那么我们期望JCG工具为我们生成的class应该是这样的：

public class Xxx {
    private String name;
    private BigDecimal price;
    private List<Yyy> nodes;
    // get、set方法省略
}
public class Yyy {
    private Integer id;
    private String note;
    // get、set方法省略
}

现在我们开始使用JCG工具将上面例子中的json解析生成class

public class JsonToClassTest {

    static {
        System.setProperty("jcg.classSavaPath", "/Users/wjy/MyProjects/JsonClassGenerator");
    }

    @Test
    public void test() {
        String json = "{\"name\":\"offer name\",\"price\":1.0,\"nodes\":[{\"id\":222,\"note\":\"xxx\"}]}";
        String className = "com.wujiuye.jcg.model.TestBean";
        
        // 我们需要为这串json定义一个类型名，
        // 然后调用JcgClassFactory的generateResponseClassByJson方法即可生成Class
        Class<?> cls = JcgClassFactory.getInstance()
                                .generateResponseClassByJson(className, json);
        try {
            // 验证生成的class是否正确
            Object obj = new Gson().fromJson(json, cls);
            System.out.println(obj.getClass());
            // 验证生成的get/set方法是否能正常调用
            Method method = obj.getClass().getDeclaredMethod("getNodes");
            Object result = method.invoke(obj);
            System.out.println(result);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

结果省略。

特色：为生成的class添加注解

为了使用某些框架的特性，我们可能需要在将json解析生成class时，就需要为class添加注解。比如我们想将JCG生成的class用于后续的json解析，那么我们可能需要在class上或者字段上添加一些诸如@JsonIgnore之类的注解，这些需求JCG都可以满足。

假设，我们想在解析json生成的class上添加一个@TestAnnno注解，可以这么实现：

public class JsonToClassTest {

    static {
        System.setProperty("jcg.classSavaPath", "/Users/wjy/MyProjects/JsonClassGenerator");
    }

    @Test
    public void test() {
        String json = "{\"name\":\"offer name\",\"price\":1.0,\"nodes\":[{\"id\":222,\"note\":\"xxx\"}]}";
        String className = "com.wujiuye.jcg.model.TestBean";
        
        // 注解规则
        AnnotationRule annotationRule = new AnnotationRule(TestAnno.class, ElementType.TYPE, "");
        annotationRule.putAttr("value", "122");
        // 注册注解规则
        AnnotationRuleRegister.registRule(className, annotationRule);

        // 调用JcgClassFactory的generateResponseClassByJson方法即可生成Class
        Class<?> cls = JcgClassFactory.getInstance()
                    .generateResponseClassByJson(className, json);
    }

}

注解规则映射类AnnotationRule的构造方法说明：

参数1：要添加的注解的类型；
参数2：注解在类上还是字段上，第二个参数和第三个参数需要配和使用。（只支持添加在类上、添加在字段上两种类型）；
参数3：添加的路径，JCG根据路径通过深度遍历寻找目标字段，如果是添加在类上，则会加在目录字段对应的class上；

如果参数2为ElementType.TYPE，参数3为""，那么结果就是在json生成的class上添加注解；如果参数2为ElementType.FIELD，参数3为""则会报错，但如果参数3为"name"，则是在name字段上添加注解。

在前面给出的json例子中，由于nodes字段是一个数组，且数组元素不是基本数据类型，因此JCG也会为数组元素生成一个class。如果想为nodes元素类型对应的class也添加注解，那么可以通过path实现。例如：

参数2为ElementType.TYPE，参数3为"nodes"，则会在nodes元素对应的类上添加注解；
参数2为ElementType.FIELD，参数3为"nodes"，则只是在nodes字段上添加注解；
参数2为ElementType.FIELD，参数3为"nodes.id"，则会在nodes元素对应的类的id字段上添加注解；

代码如下

public class JsonToClassTest {

    static {
        System.setProperty("jcg.classSavaPath", "/Users/wjy/MyProjects/JsonClassGenerator");
    }

    @Test
    public void test()  {
        String json = "{\"name\":\"offer name\",\"price\":1.0,\"nodes\":[{\"id\":222,\"note\":\"xxx\"}]}";
        String className = "com.wujiuye.jcg.model.TestBean";
        
        // 给nodes数组的元素类型class添加@TestAnno
        AnnotationRule fieldRule = new AnnotationRule(TestAnno.class, ElementType.TYPE, "nodes");
        fieldRule.putAttr("value", "12233");
        AnnotationRuleRegister.registRule(className, fieldRule);
        
        // 给nodes数组元素类型class的id字段添加注解@TestAnno
        AnnotationRule fieldClassRule = new AnnotationRule(TestAnno.class, ElementType.FIELD, "nodes.id");
        fieldClassRule.putAttr("type", ElementType.FIELD);
        AnnotationRuleRegister.registRule(className, fieldClassRule);
        
        // 调用JcgClassFactory的generateResponseClassByJson方法即可生成Class
        Class<?> cls = JcgClassFactory.getInstance()
                    .generateResponseClassByJson(className, json);
    }

}

注解规则映射类AnnotationRule的putAttr方法说明：

key: 对应注解的属性名；
value: 对应注解的属性值，属性值必须是基本数据类型、String、枚举、注解，目前不支持数组；

如果注解的属性也是注解类型，那么可以通过putAttr方法给AnnotationRule添加一个AnnotationRule实现，代理如下：

public class JsonToClassTest {

    static {
        System.setProperty("jcg.classSavaPath", "/Users/wjy/MyProjects/JsonClassGenerator");
    }

    @Test
    public void test() {
        String json = "{\"name\":\"offer name\",\"price\":1.0,\"nodes\":[{\"id\":222,\"note\":\"xxx\"}]}";
        String className = "com.wujiuye.jcg.model.TestBean";

        AnnotationRule fieldRule = new AnnotationRule(TestAnno.class, ElementType.TYPE, "nodes");
        fieldRule.putAttr("value", "12233");
        // 设置@TestAnno的map属性，该属性类型为注解类型
        AnnotationRule annoRule = new AnnotationRule(Map.class, null, "");
        annoRule.putAttr("value", "haha");
        // 
        fieldRule.putAttr("map", annoRule);
        AnnotationRuleRegister.registRule(className, fieldRule);

        // 调用JcgClassFactory的generateResponseClassByJson方法即可生成Class
        Class<?> cls = JcgClassFactory.getInstance()
                    .generateResponseClassByJson(className, json);
    }

}

生成的结果如下：

@TestAnno(
    value = "12233",
    map = @Map("haha")
)
public class TestBean$$Nodes {
    private Integer id;
    private String note;
    // get/set省略
}

TestBean$$Nodes是JCG为json中的nodes字段生成的一个class。

复杂注解的支持

针对注解属性是数组的玩法比较复杂，JCG在1.0.1版本开始支持，使用方法如下：

/**
 * @author wujiuye 2020/06/08
 */
public class JsonToClassTest {

    static {
        System.setProperty("jcg.classSavaPath", "/Users/wjy/MyProjects/JsonClassGenerator");
    }

    @Test
    public void test2() throws ClassNotFoundException {
        String json = "{\"name\":\"offer name\",\"price\":1.0,\"nodes\":[{\"id\":222,\"note\":\"xxx\"}]}";
        String className = "com.wujiuye.jcg.model.OfferBean";

        AnnotationRule fieldRule = new AnnotationRule(TestAnno.class, ElementType.TYPE, "nodes");
        fieldRule.putAttr("value", "12233");

        // 注解的属性类型为注解数组的写法
        AnnotationRule[] mapArray = new AnnotationRule[2];
        AnnotationRule annoRule = new AnnotationRule(Map.class, null, "");
        annoRule.putAttr("value", "haha");
        mapArray[0] = annoRule;
        mapArray[1] = annoRule;
        fieldRule.putAttr("mapArray", mapArray);

        // 注解的属性类型为枚举数组的写法
        ElementType[] typeArray = new ElementType[2];
        typeArray[0] = ElementType.TYPE;
        typeArray[1] = ElementType.FIELD;
        fieldRule.putAttr("typeArray", typeArray);

        AnnotationRuleRegister.registRule(className, fieldRule);

        Class<?> cls = JcgClassFactory.getInstance().generateResponseClassByJson(className, json);
        try {
            Object obj = new Gson().fromJson(json, cls);
            System.out.println(obj.getClass());
            Method method = obj.getClass().getDeclaredMethod("getNodes");
            Object result = method.invoke(obj);
            System.out.println(result);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

发布于：2021 年 06 月 27 日
作者: 吴就业
链接: https://github.com/wujiuye/json-class-generator
来源: Github开源项目：json-class-generator，未经作者许可，禁止转载!

https://github.com/wujiuye/json-class-generator