使用基于注解的mybatis时,利用反射和注解生成sql语句

最新推荐文章于 2025-06-24 10:26:02 发布
转载 最新推荐文章于 2025-06-24 10:26:02 发布 · 3.2k 阅读 · 2
文章标签：

#注解 #mybatis #反射 #sql语句

介绍了一种利用反射和自定义注解简化MyBatis插入操作的方法，解决了当对象属性较多时SQL语句冗长且易错的问题。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

在开发时遇到一个问题，在使用基于注解的mybatis插入一个对象到mysql时，在写sql语句时需要列出对象的所有属性，所以在插入一个拥有10个以上属性的对象时sql语句就会变得很长，写起来也很不方便,也很容易拼错。google了一下也没有找到什么解决方式(可能是姿势不对)，在stackoverflow上提的问题截止目前还没有人回答。所以自己想了一个基于反射和注解的解决办法
git地址：

下面是之前的代码片段:

1
2
3
@Insert ( "insert into poi_shop(name,brand,tags,status,phone,mobile,business_time,address,city,lng,lat,business_type,attribute_json) values(#{name},#{brand},#{tags},#{status},#{phone},#{mobile},#{business_time},#{address},#{city},#{lng},#{lat},#{business_type},#{attribute_json})" )
@Options (useGeneratedKeys = true , keyProperty = "id" , keyColumn = "id" )
public Long insertPoiInfo(PoiBo poiBo);

第一版(利用反射)

首先想到的是可以利用反射获得对象的所有属性，然后拼接成sql语句。所以写了一个基于反射拼装sql语句的方法，然后基于mybatis动态获得sql语句的方式 获得完整的sql 具体的代码如下:
接口层改为下面的样子，sql语句的生成放到PoiSqlProvider的insertPoiBo方法中

1
2
@InsertProvider (type = PoiSqlProvider. class , method = "insertPoiBo" )
public Long insertPoiInfo( @Param ( "poiBo" )PoiBo poiBo);

PoiSqlProvider.class

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
   public String insertPoiBo(Map<String,Object> map){
        PoiBo poiBo = (PoiBo)map.get( "poiBo" );
        StringBuilder sql = new StringBuilder( "insert into poi_shop " );
        //get sql via reflection
        Map<String,String> sqlMap = getAllPropertiesForSql(poiBo, "poiBo" );
        //
        sql.append(sqlMap.get( "field" )).append(sqlMap.get( "value" ));
        System.out.println(sql.toString());
        return sql.toString();
 
    }
 
//根据传入的对象 基于反射生成两部分sql语句
    private  Map<String,String> getAllPropertiesForSql(Object obj, String objName){
 
        Map<String,String> map = new HashMap<String,String>();
         if ( null == obj) return map;
        StringBuilder filedSql = new StringBuilder( "(" );
        StringBuilder valueSql = new StringBuilder( "value (" );
        Field[] fields = obj.getClass().getDeclaredFields();
        for ( int i = 0 ; i < fields.length; i++) {
            filedSql.append(fields[i].getName() + "," );
            valueSql.append( "#{" + objName + "." + fields[i].getName() + "}," );
        }
 
        //remove last ','
        valueSql.deleteCharAt(valueSql.length() - 1 );
        filedSql.deleteCharAt(filedSql.length() - 1 );
        valueSql.append( ") " );
        filedSql.append( ") " );
        map.put( "field" ,filedSql.toString());
        map.put( "value" , valueSql.toString());
 
        System.out.println( "database filed sql: " + filedSql.toString());
        System.out.println( "value sql:" + valueSql.toString());
 
        return map;
    }

下面是基于反射生成的两部分sq语句和最后拼接的语句

1
2
3
4
5
6
7
8
9
database filed sql:
 
(id, name ,brand,tags,status,phone,mobile,business_time,address,city,lng,lat,business_type,attribute_json,updated_at,created_at)
 
value sql:
 
value(#{poiBo.id},#{poiBo. name },#{poiBo.brand},#{poiBo.tags},#{poiBo.status},#{poiBo.phone},#{poiBo.mobile},#{poiBo.business_time},#{poiBo.address},#{poiBo.city},#{poiBo.lng},#{poiBo.lat},#{poiBo.business_type},#{poiBo.attribute_json},#{poiBo.updated_at},#{poiBo.created_at})
 
insert into poi_shop (id, name ,brand,tags,status,phone,mobile,business_time,address,city,lng,lat,business_type,attribute_json,updated_at,created_at) value (#{poiBo.id},#{poiBo. name },#{poiBo.brand},#{poiBo.tags},#{poiBo.status},#{poiBo.phone},#{poiBo.mobile},#{poiBo.business_time},#{poiBo.address},#{poiBo.city},#{poiBo.lng},#{poiBo.lat},#{poiBo.business_type},#{poiBo.attribute_json},#{poiBo.updated_at},#{poiBo.created_at})

要注意的是如果数据库的字段名和插入对象的属性名不一致，那么不能使用生成的database filed sql。

最终版(加入注解)

上面的getAllPropertiesForSql方法有个缺点，如果数据库的字段名和类的属性名不一致，就不能依靠反射获得sql了。所以借鉴老大的ORM框架也写了一个注解Column，用于model类的属性上，表明属性所对应数据库字段。下面是Column注解的snippet。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
/* 定义字段的注解*/
@Retention(RetentionPolicy.RUNTIME)
/*该注解只能用在成员变量上*/
@Target(ElementType.FIELD)
public @interface Column {
 
     /**
      * 用来存放字段的名字 如果未指定列名，默认列名使用成员变量名
      *
      * @return
      */
     String name() default "" ;
     }

之后在model类属性上加入对应的注解,省略getter和setter。Column的name为空时，代表属性名和字段名一致。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
public class PoiBo {
 
     @Column
     private Long id;
     @Column (name = "poi_name" )
     private String name; //表示name属性对应数据库poi_name字段
     @Column (name = "poi_brand" )
     private String brand; //表示brand属性对应数据库poi_brand字段
     @Column
     private String tags;
     @Column
     private Integer status;
     @Column
     private String phone;
     @Column
     private String mobile;
     @Column
     private String business_time;
     @Column
     private Float average_price;
     @Column
     private String address;
     @Column
     private String city;
     @Column
     private Double lng;
     @Column
     private Double lat;
     @Column
     private String business_type;
     @Column
     private String attribute_json;
     @Column
     private Timestamp updated_at;
     @Column
     private Timestamp created_at;
     }

修改getAllPropertiesForSql方法，通过获取类属性上的注解获得数据库字段名。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
private  Map<String,String> getAllPropertiesForSql(Object obj, String objName){
 
         Map<String,String> map = new HashMap<String,String>();
          if ( null == obj) return map;
         StringBuilder filedSql = new StringBuilder( "(" );
         StringBuilder valueSql = new StringBuilder( "value (" );
         Field[] fields = obj.getClass().getDeclaredFields();
         for (Field field : fields) {
                 // 判断该成员变量上是不是存在Column类型的注解
                 if (!field.isAnnotationPresent(Column. class )) {
                     continue ;
                 }
 
                 Column c = field.getAnnotation(Column. class ); // 获取实例
                 // 获取元素值
                 String columnName = c.name();
                 // 如果未指定列名，默认列名使用成员变量名
                 if ( "" .equals(columnName.trim())) {
                     columnName = field.getName();
                 }
 
             filedSql.append(columnName + "," );
             valueSql.append( "#{" + objName + "." + field.getName() + "}," );
         }
         //remove last ','
         valueSql.deleteCharAt(valueSql.length() - 1 );
         filedSql.deleteCharAt(filedSql.length() - 1 );
         valueSql.append( ") " );
         filedSql.append( ") " );
         map.put( "field" ,filedSql.toString());
         map.put( "value" , valueSql.toString());
 
         System.out.println( "database filed sql: " + filedSql.toString());
         System.out.println( "value sql:" + valueSql.toString());
 
         return map;
     }

利用反射+注解之后的输出结果，可以看到sql语句正确按照name的Column注解的输出了name属性对应的数据库字段是poi_name.

1
2
3
4
5
6
7
8
9
database filed sql:
 
(id,poi_name,poi_brand,tags,status,phone,mobile,business_time,average_price,address,city,lng,lat,business_type,attribute_json,updated_at,created_at)
 
value sql:
value(#{poiBo.id},#{poiBo. name },#{poiBo.brand},#{poiBo.tags},#{poiBo.status},#{poiBo.phone},#{poiBo.mobile},#{poiBo.business_time},#{poiBo.average_price},#{poiBo.address},#{poiBo.city},#{poiBo.lng},#{poiBo.lat},#{poiBo.business_type},#{poiBo.attribute_json},#{poiBo.updated_at},#{poiBo.created_at})
 
insert into poi_shop
(id,poi_name,poi_brand,tags,status,phone,mobile,business_time,average_price,address,city,lng,lat,business_type,attribute_json,updated_at,created_at) value (#{poiBo.id},#{poiBo. name },#{poiBo.brand},#{poiBo.tags},#{poiBo.status},#{poiBo.phone},#{poiBo.mobile},#{poiBo.business_time},#{poiBo.average_price},#{poiBo.address},#{poiBo.city},#{poiBo.lng},#{poiBo.lat},#{poiBo.business_type},#{poiBo.attribute_json},#{poiBo.updated_at},#{poiBo.created_at})

原文出处：  Giraffe
from: http://www.importnew.com/22918.html
mybatis框架执行原理简单实现
congge
04-27 3061
mybatis实现数据库交互的原理 反射+jdk动态代理 我们在使用传统的JDBC做数据库交互的时候，要想对返回的结果进行处理，需要通过反射和结果集的游标进行层层解析，是不是觉得很麻烦，确实尤其当我们需要查询的结果变成我们自定义的对象的时候发现比较难做，这是因为jdbc查出来的结果并没有做orm的映射转化，需要我们手动进行封装，所以mybatis的使用，可以让框架帮我们解决这个事情，但mybati...
Mybatis SQL注解使用场景
崔同学的博客
07-12 1524
Mybatis SQL注解使用场景
利用JAVA注解与反射 - 实现SQL语句自动生成
08-04
利用JAVA注解实现SQL语句自动生成 编写对应Entity添加相关注解，并通过SqlUtil工具，传入相关参数生成SQL语句 例如：要生成对应数据库Person的SQL增删改查 SqlUtil.create(Person.class) SqlUtil.insert(Person.class) SqlUtil.insert(Person.class,person) SqlUtil.updateById(Person.class,person) SqlUtil.deleteById(Person.class,person) 开发工具IDEA，MAVEN项目
mybatis 利用反射批量插入
chounakai0939的博客
12-03 208
publicStringinsertAll(Map<String,List<?>>map){ List<?>list=map.get("list"); StringBuildersql=newS...
MyBatis注解解析
最新发布
m0_75107803的博客
06-24 946
场景推荐方案简单CRUD操作直接使用@Select@Insert等注解多参数查询@Param注解命名参数列名-属性名映射@Results@Result一对一/一对多关系@One@Many嵌套查询简单动态SQL<script>标签内嵌XML复杂动态SQL动态生成SQL批量操作@Flush+ BATCH 执行器存储过程调用复杂结果映射结合XML定义 resultMap需要二级缓存最佳实践原则简单优先：优先使用注解实现简单逻辑。复杂XML：动态SQL和复杂映射优先采用XML配置。
java string char数组_String、StringBuilder、StringBuffer源码分析
weixin_39758618的博客
12-02 215
String 源码 private final char value[]; public String() { this.value = "".value; } public String(String original) { this.value = original.value; this.hash = original.hash;...
MyBatis注解配置映射器：动态SQL的实现
08-22
java工程，练习通过MyBatis注解的方式配置SQL映射器，实现动态SQL.
Mybatis基于注解形式的sql语句生成实例代码
08-29
Mybatis基于注解形式的sql语句生成实例代码是指使用Mybatis框架提供的注解形式来生成sql语句，以提高开发效率和代码可读性。 在Mybatis中，使用注解形式可以将sql语句与java代码紧密耦合，实现了sql语句的动态生成...
demo.zip_Mybatis注解时的sql语句拼接方法_SSM 注解_SSM分页查询_mybatis注解分页_基于ssm
09-24
`demo.zip`中提供的Java类很可能是为了弥补这个不足，通过编写辅助方法，将分页条件（如页码和每页大小）与基本的查询语句合并，生成完整的带有分页的SQL语句。这种方法可能包括以下几个步骤： 1. 定义一个公共的...
mybatis-demo12-动态SQL语句2-基于注解配置.zip
08-05
综上所述，"mybatis-demo12-动态SQL语句2-基于注解配置"这个项目旨在展示如何在MyBatis中使用注解实现动态SQL，从而更好地理解MyBatis的这一强大特性。通过学习和实践，开发者可以更加熟练地运用MyBatis进行数据库...
Spring Boot整合mybatis使用注解实现动态Sql、参数传递等常用操作(实现方法)
09-07
在Spring Boot项目中整合Mybatis并利用注解进行数据库操作，可以极大地简化开发流程，提高效率。本文主要讲解如何使用注解实现动态SQL和参数传递等常见功能。 首先，Spring Boot与Mybatis的整合通常通过添加相关...
通过反射实现Mybatis注解开发@Select
qq_37274338的博客
06-27 1251
在mybatis中，可以通过注解@Select（sql语句）对接口进行注释，并且实现开发，那么，如何自己实现呢？ 首先需要对注解和反射机制具有一定的了解。这些属于基础知识，这里不赘述。 一、测试项目目录结构 使用的测试数据库是Oracle数据库，使用的表是scott用户下的dept表。（这里使用什么数据库并没有什么意义） Dept.java： 这是用来保存实体数据的类，查询的数据最终...
Mybatis根据Bean生成对应的SQL语句工具类
qq_44717657的博客
05-11 1804
Mybatis根据Bean生成对应的SQL语句工具类 Mybatis便捷开发 工具类
Mybatis编写SQL
wuweixiaoyue的博客
06-02 2385
预编译SQL。
mybatis如何生成和执行动态sql
tobebetter9527的博客
08-12 1209
include> 标签由XMLIncludeTransformer.applyIncludes(）处理，同时还会处理 标签下的标签和“${}"占位符。作用是引入由标签定义的sql片段，实际在XMLMapperBuilder.sqlElement()解析。在CachingExecutor.query()生成真正待执行的sql。进入getBoundSql(),
Mybatis-Plus：实现自定义SQL
热门推荐
拾一二的博客
06-26 4万+
Mybatis-Plus（以下简称MBP）的初衷是为了简化开发，而不建议开发者自己写SQL语句的；但是有时客户需求比较复杂，仅使用MBP提供的Service，Mapper与Wrapper进行组合，难以实现可以需求；这时我们就要用到自定义的SQL了。Java 开发使用 mybatis-plus 来执行 sql 操作，往往比 mybatis 能够省时省力，因为 mybatis-plus 封装了很多常用的接口。但对于一些更为复杂的查询来说，mybatis-plus 也相形见绌，还得需要我们自定义 sql 语句。
【Mybatis】如何简单使用mybatis-plus，以及MybatisGenerator自动生成或者实现SQL语句
GGBond778的博客
02-28 3218
本期主要讲解了关于mybatis-plus的简单使用，以及MybatisGenerator对于SQL，实体类,DAO层的代码自动实现
java 反向工程mysql_Java程序员开发必备 MyBatis高级应用之逆向工程自动生成SQL语句...
weixin_34163588的博客
01-21 242
本文以Spring整合MyBatis环境下,介绍MyBatis逆向工程自动生成pojo，mapper,dao的Java类。MyBatis的一个主要的特点就是需要程序员自己编写sql，那么如果表太多的话，难免会很麻烦，所以mybatis官方提供了一个逆向工程，可以针对单表自动生成mybatis执行所需要的代码，一般在开发中，常用的逆向工程方式是通过数据库的表生成代码。下图为逆向工程依赖的jar包my...
Mybatis-构建SQL语句
金鳞踏雨
03-02 1639
SQL构建对象介绍 我们之前通过注解开发时，相关 SQL 语句都是自己直接拼写的。一些关键字写起来比较麻烦、而且容易出错。 MyBatis 给我们提供了 org.apache.ibatis.jdbc.SQL 功能类，专门用于构建 SQL 语句。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值