[附一]: spring 为什么可以获取参数名而mybatis不

2021-05-14 本文已影响0人 lj72808up

1. 为什么可以获得函数的参数名?

一般 javac 编译出的 .class 方法是不包含参数名的, 但 .class 文件除了反编译出的类, 还包含额外的信息, 其中对日常最有用的2个概念是:

LineNumberTable
记录字节码偏移量和代码行号的 (抛异常时, 显示的哪行代码出错, 就是用的 LineNumberTable 的信息)
LocalVariableTable (本地变量表)
记录了方法中的局部变量和源代码中的局部变量的对应关系 (获取函数的参数名等)

ASM 可以读取 .class 文件中的 LocalVariableTable

2. 获得参数名的3个方法:

如果是 java8, 在编译时加上 -parameters 参数 java.lang.reflect.Parameter 自动解析编译在 .class 文件的输出获取参数名

示例

类中使用 Parameter 反射

public class TestParamName {
    public static void main1(String[] args) throws NoSuchMethodException {
        Method method = TestParamName.class.getMethod("test1", String.class, Integer.class);
        int parameterCount = method.getParameterCount();
        Parameter[] parameters = method.getParameters();

        // 打印输出：
        System.out.println("方法参数总数：" + parameterCount);
        Arrays.stream(parameters).forEach(
                p -> System.out.println(p.getType() + "----" + p.getName())
        );

    }

    public void test1(String name, Integer age) {
        System.out.println(name + "::" + age);
    }
}

javac 上加上 -parameters 参数编译额外信息

javac -parameters TestParamName.java

输出:

// 编译时加上 -parameters 参数, 输出: 
方法参数总数：2
class java.lang.String----name
class java.lang.Integer----age

// 编译时不加 -parameters 参数, 输出: 
方法参数总数：2
class java.lang.String----arg0
class java.lang.Integer----arg1

缺点

这种方式强制要求编译时增加参数, 且 java 版本在 1.8以上. 编译参数往往每个人不一样. 解决办法是通过 maven 插件打包. (但是这容易和 idea 开发时输出不一致, idea 的 java compiler 选项可能没加 -parameters 参数)

<!-- 编译环境在1.8编译 且附加编译参数：-parameters-->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.8.0</version>
    <configuration>
        <!-- 编译参数 -->
        <compilerArgs>
            <arg>-parameters</arg>
        </compilerArgs>
        <source>${java.version}</source>
        <target>${java.version}</target>
        <compilerVersion>${java.version}</compilerVersion>
        <encoding>${project.build.sourceEncoding}</encoding>
    </configuration>
</plugin>

如果是 java8 以下, 添加 -g 参数, 但因为没有 java.lang.reflect.Parameter 类, 需要自己使用 javap -verbose 将局部变量日志输出, 然后进行解析.
- 缺点: 代码里需要解析 javap 的输出

使用 ASM 工具 (推荐)
ASM 是一个字节码操控框架, 它能够动态增强类功能, 改变类型为, 甚至生成新类

3. Spring mvc 为何可以推断出参数名, 而 Mybatis 推断不出来?

有一个很疑惑的现象是:
- 在使用Spring MVC的时候, 即便不加 @Param 注解, 也可以将 json 的 key 和 controller 方法的参数绑定
- 在使用MyBatis（接口模式）时，接口方法向 sql 语句传参时，必须使用@Param('')指定函数参数和 sql 参数的绑定关系
几种操作字节码方式的区别
- ASM：操纵底层的 JVM 汇编指令. 要求使用者对class组织结构和JVM汇编指令有一定的了解
- java 动态代理:
  动态代理是调用 Proxy的newProxyInstance()方法 创建一个新的代理类 $Proxy0, 内部是一系列反射 constructor . 该代理类继承自 java.lang.reflect.Proxy, 且 implement 了需要代理的接口. $Proxy0 extends Proxy implements MyInterface{ ... }.
  java 的单继承机制决定了不能对抽象类代理, 只能对接口代理
- CGLIB 动态代理: 使用 ASM 框架操纵类实现对类(或接口)的代理

3.为什么 spring mvc 可以自定映射 json key 和方法参数名?
Spring MVC 借助 ASM 来实现参数名读取, 不依赖于 -parameters 参数，也不依赖于 -g 编译参数. 最终依赖 spring core 的 DefaultParameterNameDiscoverer 类获取参数名

```java
public class DefaultParameterNameDiscoverer extends PrioritizedParameterNameDiscoverer {
    public DefaultParameterNameDiscoverer() {
        if (KotlinDetector.isKotlinReflectPresent() && !GraalDetector.inImageCode()) {
            addDiscoverer(new KotlinReflectionParameterNameDiscoverer());
        }
        addDiscoverer(new StandardReflectionParameterNameDiscoverer());
        addDiscoverer(new LocalVariableTableParameterNameDiscoverer());
    }

    // 只要有一个处理器获取了参数名, 就返回
    public String[] getParameterNames(Method method) {
        for (ParameterNameDiscoverer pnd : this.parameterNameDiscoverers) {
            String[] result = pnd.getParameterNames(method);
            if (result != null) {
                return result;
            }
        }
        return null;
    }
}
```

DefaultParameterNameDiscoverer 使用职责链模式处理参数名获取. 职责链中包括 StandardReflectionParameterNameDiscoverer 和 LocalVariableTableParameterNameDiscoverer. 前者依赖 -parameters 的编译输出; 后者使用 ASM 实现参数名解析

为什么 Mybatis 的 dao 无法自动完成方法参数名和 sql 参数名的映射

首先, ASM 有个问题是, 无法获得 interface 的方法的参数名.
因为对于抽象方法没有方法体, 也就不存在方法内的局部变量, 也就没有记录对应的 LocalVariableTable . 所以 ASM 无法读取
Mybatis 是通过接口和 sql 绑定后生成代理类完成的查询映射, 所以使用 ASM 也无法获取参数名

Mapper
@Repository // 这个注解可以不加, 纯粹是为了 idea 在 autowired 中不报错
public interface CasbinDao {
    // todo  测试自动生成 id
    @Insert("INSERT INTO casbin_rule(id, p_type, v0, v1) VALUES(#{id}, #{pType}, #{v0}, #{v1})")
    @Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id")
    int insert(CasbinRule casbin);

    @Update(value = {
            "<script>",
            "UPDATE users",
            "<set>",
            "<if test='username != null'>, username = #{username}</if>",
            "<if test='password != null'>, password = #{password}</if>",
            "</set>",
            "WHERE id = #{id}",
            "</script>"
    })
    int updateById(CasbinRule user);
}

但是, 如果在编译时加上 -parameters 参数, 是可以使用 java8 的反射获取参数名的. 因为它不依赖 LocalVariableTable. 单位了兼容性, mybatis 放弃了这种做法

[附一]: spring 为什么可以获取参数名而mybatis不

1. 为什么可以获得函数的参数名?

2. 获得参数名的3个方法:

3. Spring mvc 为何可以推断出参数名, 而 Mybatis 推断不出来?

猜你喜欢

热点阅读