本节内容:【案例 9-1】利用反射自动生成 INSERT SQL 语句
一、案例概述与核心原理
1. 案例需求
编写一个通用工具方法,传入任意一个 Java 实体对象,即可自动生成对应的 INSERT 插入 SQL 语句,无需为每个实体类手动编写 SQL。
2. 核心原理
利用 Java 反射机制,在运行时动态获取实体类的所有成员变量(字段名)和对象对应的字段值,按照 SQL 语法规则自动拼接字符串。
3. 应用意义
这是 ORM(对象关系映射)框架的底层核心逻辑,MyBatis、JPA/Hibernate 等框架的自动 SQL 生成功能,底层都基于反射 + 注解的思路实现。
二、实现思路
- 获取传入对象的
Class对象 - 通过
Class对象获取本类所有声明的字段 - 开启暴力反射,取消字段的访问权限检查
- 遍历字段数组,分别收集「列名(字段名)」和「字段值」
- 按照 INSERT 语法拼接完整 SQL:
INSERT INTO 表名 (列1,列2) VALUES (值1,值2) - 对字符串、字符等类型的值自动添加单引号,数值类型不添加
三、完整代码实现
1. 准备实体类
public class Student {
private Integer id;
private String name;
private Integer age;
private String gender;
public Student() {}
public Student(Integer id, String name, Integer age, String gender) {
this.id = id;
this.name = name;
this.age = age;
this.gender = gender;
}
}
2. SQL 生成工具类
import java.lang.reflect.Field;
public class SqlGenerator {
/**
* 根据实体对象生成 INSERT SQL 语句
* @param obj 实体对象
* @return 拼接完成的SQL语句
*/
public static String generateInsert(Object obj) throws IllegalAccessException {
// 1. 获取对象的Class对象
Class<?> clazz = obj.getClass();
// 2. 取类名作为表名(实际开发可做驼峰转下划线处理)
String tableName = clazz.getSimpleName();
// 3. 获取本类所有声明的字段
Field[] fields = clazz.getDeclaredFields();
// 分别拼接列名部分和值部分
StringBuilder columns = new StringBuilder();
StringBuilder values = new StringBuilder();
for (int i = 0; i < fields.length; i++) {
Field field = fields[i];
// 开启暴力反射,突破私有访问限制
field.setAccessible(true);
// 获取字段名作为数据库列名
String columnName = field.getName();
// 获取当前对象的字段值
Object fieldValue = field.get(obj);
// 拼接列名
columns.append(columnName);
// 拼接值:字符串/字符类型加单引号
if (fieldValue instanceof String || fieldValue instanceof Character) {
values.append("'").append(fieldValue).append("'");
} else {
values.append(fieldValue);
}
// 非最后一个字段,追加逗号分隔
if (i != fields.length - 1) {
columns.append(", ");
values.append(", ");
}
}
// 4. 拼接完整SQL并返回
return String.format("INSERT INTO %s (%s) VALUES (%s);",
tableName, columns, values);
}
}
3. 测试类
public class TestSqlGenerator {
public static void main(String[] args) throws IllegalAccessException {
Student stu = new Student(1001, "张三", 20, "男");
String sql = SqlGenerator.generateInsert(stu);
System.out.println(sql);
}
}
运行输出结果:
INSERT INTO Student (id, name, age, gender) VALUES (1001, '张三', 20, '男');
四、核心代码解析
-
字段获取方式 使用
getDeclaredFields()获取本类全部字段(包含私有);实体类字段通常为私有,不能使用只能获取 public 成员的getFields()。 -
暴力反射开关
field.setAccessible(true)用于取消 Java 的访问权限检查,是读取私有字段值的必要操作。 -
字段值读取
field.get(obj)可以获取指定对象上该字段的值,返回类型为Object,需要根据业务做类型判断与处理。 -
SQL 值类型处理 字符串、字符类型在 SQL 语法中需要用单引号包裹,数值类型不需要;实际开发还需额外处理日期、null 值等场景。
-
表名映射规则 示例直接使用类名作为表名。企业开发中通常会做「驼峰命名转下划线命名」,例如类名
UserInfo对应表名user_info。
五、易错点与优化方向
易错点汇总
- 忘记调用
setAccessible(true),操作私有字段会直接抛出IllegalAccessException。 - 字符串类型的值遗漏单引号,会导致 SQL 语法错误。
getDeclaredFields()只能获取本类字段,无法获取父类继承的字段;若实体类有父类,需要递归向上获取父类字段。- 字段值为
null时,直接拼接会输出字符串null,SQL 中应写NULL关键字,需要单独判断处理。 - 字段名与数据库列名不一致时,直接使用字段名会导致 SQL 执行失败,通常配合自定义注解完成字段映射。
常见优化方向
- 增加驼峰命名与下划线命名的转换,适配数据库命名规范。
- 增加 null 值判断,空值统一拼接为 SQL 的
NULL。 - 支持自定义表名、自定义列名(配合注解实现)。
- 扩展生成 UPDATE、SELECT、DELETE 等其他类型的 SQL 语句。
- 适配日期、枚举等特殊数据类型的 SQL 值格式。