mybatis源码之旅 - PropertyNamer：属性名与方法名的桥梁

2024-01-31 06:42:45

在MyBatis源码的海洋中，有一个不起眼却举足轻重的工具类——PropertyNamer。它是MyBatis用来处理属性名和方法名的桥梁，在整个框架中扮演着重要的角色。今天，我们将踏上MyBatis源码之旅，一起探究PropertyNamer的奥秘，看看它是如何将属性名与方法名巧妙地连接起来的。

反射的奥义

PropertyNamer离不开反射机制，反射是Java语言的一项强大特性，它允许程序在运行时检查和操作类的信息。通过反射，我们可以动态地获取类的属性、方法、构造函数等信息，并对它们进行操作。

在MyBatis中，PropertyNamer正是利用反射来获取getter/setter方法对应的属性名称。通过反射，PropertyNamer可以获取到一个类中的所有方法，然后对每个方法进行分析，判断它是否符合getter/setter方法的命名规范。

PropertyNamer的职责

PropertyNamer主要有两个职责：

获取getter/setter方法对应的属性名称
校验方法名称是否是getter/setter方法

对于第一个职责，PropertyNamer使用正则表达式来匹配getter/setter方法的命名规范。正则表达式是一种强大的字符串匹配工具，它可以帮助我们快速地从一长串字符中找到符合特定模式的子字符串。

对于第二个职责，PropertyNamer使用了一个名为“isGetter”和“isSetter”的方法来校验方法名称是否符合getter/setter方法的命名规范。这两个方法分别用来判断一个方法是否是getter方法或setter方法。

PropertyNamer的实现细节

PropertyNamer的实现非常简洁，它只包含了几个方法，每个方法都非常精巧，充分体现了Java语言的简洁性和灵活性。

public class PropertyNamer {

    private static final Map<String, String> propertyToFieldMap = new HashMap<>();

    private static final Map<String, String> fieldToPropertyMap = new HashMap<>();

    private static final char SEPARATOR = '_';

    public static String methodToProperty(String name) {
        if (name.startsWith("get") || name.startsWith("set")) {
            return separatorToCamelCase(name.substring(3), false);
        }
        return separatorToCamelCase(name, false);
    }

    public static String propertyToMethod(String name) {
        if (name.startsWith("get") || name.startsWith("set")) {
            throw new RuntimeException("Error calling PropertyNamer.propertyToMethod() with getter/setter property names");
        }
        return "get" + separatorToCamelCase(name, true);
    }

    private static String separatorToCamelCase(String name, boolean preserveActuallyUppercase) {
        StringBuilder sb = new StringBuilder();
        boolean nextUpperCase = false;
        for (int i = 0; i < name.length(); i++) {
            char c = name.charAt(i);
            boolean hasNextChar = (i + 1) < name.length();
            if (c == SEPARATOR) {
                if (hasNextChar && name.charAt(i + 1) == SEPARATOR) {
                    sb.append(SEPARATOR);
                    i++;
                } else {
                    nextUpperCase = true;
                }
            } else if (nextUpperCase) {
                sb.append(Character.toUpperCase(c));
                nextUpperCase = false;
            } else {
                sb.append(c);
            }
        }
        return preserveActuallyUppercase ? sb.toString() : sb.toString().toLowerCase();
    }
}