AI 助理
备案控制台
开发者社区 数据库 文章 正文

Mybatis基于接口注解配置SQL映射器(一)

2017-10-24 2014
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 上文已经讲解了基于XML配置的SQL映射器,在XML配置的基础上MyBatis提供了简单的Java注解，使得我们可以不配置XML格式的Mapper文件，也能方便的编写简单的数据库操作代码。Mybatis之接口注解映射语句@Insert可以使用@Insert注解来定义一个INSERT映射语句：...

上文已经讲解了基于XML配置的SQL映射器,在XML配置的基础上MyBatis提供了简单的Java注解，使得我们可以不配置XML格式的Mapper文件，也能方便的编写简单的数据库操作代码。

Mybatis之接口注解

映射语句

@Insert

可以使用@Insert注解来定义一个INSERT映射语句：

 1  @Insert(" insert into sys_user (id, username, password, " +
 2             "      name, sex, status, org_id, " +
 3             "      email, idcard, is_admin, " +
 4             "      sort, mobile, stationid" +
 5             "      )" +
 6             "    values (#{id}, #{username}, #{password}," +
 7             "      #{name}, #{sex}, #{status}, #{orgId}, " +
 8             "      #{email}, #{idcard}, #{isAdmin}, " +
 9             "      #{sort}, #{mobile}, #{stationid}" +
10             "      )")
11     int insertUser(sysUser sysuser);
View Code
[自动生成主键]

在上一章中我们讨论过主键列值可以自动生成。我们可以使用@Options注解的userGeneratedKeys 和keyProperty属性让数据库生成AUTO_INCREMENT列的值

 1    @Insert(" insert into sys_user ( username, password, " +
 2             "      name, sex, status, org_id, " +
 3             "      email, idcard, is_admin, " +
 4             "      sort, mobile, stationid" +
 5             "      )" +
 6             "    values ( #{username}, #{password}," +
 7             "      #{name}, #{sex}, #{status}, #{orgId}, " +
 8             "      #{email}, #{idcard}, #{isAdmin}, " +
 9             "      #{sort}, #{mobile}, #{stationid}" +
10             "      )")
11     @Options(useGeneratedKeys = true, keyProperty = "id")
12     int insertUser2(sysUser sysuser);
View Code

有些数据库如Oracle并不支持 AUTO_INCREMENT 列，其使用序列（SEQUENCE），或者其他查询（uuid）来生成主键值，如下所示：

 1 @Insert(" insert into sys_user ( username, password, " +
 2             "      name, sex, status, org_id, " +
 3             "      email, idcard, is_admin, " +
 4             "      sort, mobile, stationid" +
 5             "      )" +
 6             "    values ( #{username}, #{password}," +
 7             "      #{name}, #{sex}, #{status}, #{orgId}, " +
 8             "      #{email}, #{idcard}, #{isAdmin}, " +
 9             "      #{sort}, #{mobile}, #{stationid}" +
10             "      )")
11     @SelectKey(statement=" SELECT replace(uuid(),'-','')  AS id",
12             keyProperty="id", resultType=String.class, before=true)
13     int insertUser3(sysUser sysuser);
View Code

@Update

可以使用@Update注解来定义一个UPDATE映射语句：

 1 @Update("update sys_user" +
 2             "    set username = #{username}," +
 3             "      password = #{password}," +
 4             "      name = #{name}," +
 5             "      sex = #{sex}," +
 6             "      status = #{status}," +
 7             "      org_id = #{orgId}," +
 8             "      email = #{email}," +
 9             "      idcard = #{idcard}," +
10             "      is_admin = #{isAdmin}," +
11             "      sort = #{sort}," +
12             "      mobile = #{mobile}," +
13             "      stationid = #{stationid}" +
14             "    where id = #{id}")
15     int updateUser(sysUser sysuser);
View Code

@Delete

可以使用@Delete  注解来定义一个DELETE映射语句：

1   @Delete("delete from sys_user WHERE id=#{id}")
2     int deleteUser(String id);
View Code

@Select

可以使用@ Select注解来定义一个SELECT映射语句：

1     @Select("SELECT * FROM sys_user WHERE username = #{username}")
2     sysUser findByUsername(@Param("username") String username);
3 
4     @Select("SELECT * FROM sys_user WHERE id = #{id}")
5     sysUser findById(@Param("id") String id);
View Code

结果映射

 我们可以将查询结果通过别名或者是@Results注解与JavaBean属性映射起来：

1 @Select("SELECT * FROM sys_user WHERE username = #{username}")
2     @Results(
3             {
4                     @Result(id = true, column = "id", property = "id"),
5                     @Result(column = "password", property = "password"),
6                     @Result(column = "name", property = "name"),
7                     @Result(column = "sex", property = "sex")
8             })
9     sysUser findByUsername(@Param("username") String username);
View Code

一对一映射

MyBatis提供了@One注解来使用嵌套select语句（Nested-Select）加载一对一关联查询数据。MyBatis3.2.2版本，并没有对应的注解支持嵌套结果ResultMap。

 1  @Select("SELECT * FROM sys_user WHERE id = #{id}")
 2     @Results(
 3      {
 4         @Result(id = true,column = "id", property = "id"),
 5         @Result(column = "password", property = "password"),
 6         @Result(column = "name", property = "name"),
 7         @Result(column = "sex", property = "sex"),
 8         @Result(property = "sysuserinfo", column = "id",
 9            one = @One(select = "com.goku.mybatis.mapper.sysUserMapper.findsysUserInfo"))
10      })
11     sysUser findsysUser(@Param("id") String id);
12 
13     @Select("select * from sys_user_info where id=#{id}")
14     sysUserInfo findsysUserInfo(String id);
View Code

一对多映射

MyBatis提供了@Many注解来使用嵌套Select语句加载一对多关联查询。

 1  @Select("SELECT * FROM sys_org WHERE id = #{id}")
 2     @Results(
 3     {
 4             @Result(id = true,column = "id", property = "id"),
 5             @Result(column = "version", property = "version"),
 6             @Result(column = "level", property = "level"),
 7             @Result(column = "type", property = "type"),
 8             @Result(property = "sysuser", column = "id",
 9                     many = @Many(select = "com.goku.mybatis.mapper.sysUserMapper.findByOrgId"))
10     })
11     sysOrg findsysOrg(@Param("id") String id);
12 
13     @Select("SELECT * FROM sys_user WHERE org_id = #{id}")
14     sysUser findByOrgId(String id);
View Code

动态SQL

有时候我们需要根据输入条件动态地构建SQL语句。MyBatis提供了各种注解如@InsertProvider,@UpdateProvider,@DeleteProvider和@SelectProvider，来帮助构建动态SQL语句，然后让MyBatis执行这些SQL语句。

 @SelectProvider

可以使用org.apache.ibatis.jdbc.SQL工具类来构建SQL语句：

 1 public String findUserByIdSql()
 2     {
 3         return new SQL()
 4         {
 5             {
 6                 SELECT("*");
 7                 FROM("sys_user");
 8                 WHERE("id=#{id}");
 9             }
10         } .toString();
11     }
View Code

可以使用@SelectProvider注解来创建一个SELECT映射语句：

1    @SelectProvider(type=sysUserDynaSqlProvider.class, method="findUserByIdSql")
2     sysUser findUserByIdSql(@Param("id") String id);
View Code

SQL工具类会处理以合适的空格前缀和后缀来构造SQL语句。

动态SQL provider方法可以接收以下其中一种参数：

  •      无参数
  •      和映射器Mapper接口的方法同类型的参数
  •      java.util.Map

例如 映射器Mapper接口方法只有一个参数，那么可以定义SQLProvider方法，它接受一个与Mapper接口方法相同类型的参数：

 1  public String findUserByIdSql(final String id)
 2     {
 3         return new SQL()
 4         {
 5             {
 6                 SELECT("*");
 7                 FROM("sys_user");
 8                 WHERE("id='"+id+"'");
 9             }
10         } .toString();
11     }
View Code

如果映射器Mapper接口有多个输入参数，我们可以使用参数类型为java.util.Map的方法作为SQLprovider方法。MyBatis提供的多值映射参数，使用的是#{param}语法。

 1 public String findUserByIdSql2(Map<String, Object> map)
 2     {
 3         return new SQL()
 4         {
 5             {
 6                 SELECT("*");
 7                 FROM("sys_user");
 8                 WHERE("id=#{param1} and username=#{param2}");
 9             }
10         } .toString();
11     }
12 
13     @SelectProvider(type=sysUserDynaSqlProvider.class, method="findUserByIdSql2")
14     sysUser findUserByIdSql2(String id, String name);
View Code

SQL工具类也提供了其他的方法来表示JOINS，ORDER_BY，GROUP_BY等等。

例如 使用LEFT_OUTER_JOIN的例子：

 1  public String findUserinfoByIdSql()
 2     {
 3         return new SQL()
 4         {
 5             {
 6                 SELECT("u.id, username, password, name, sex, status, org_id, email, idcard, is_admin, sort," +
 7                         "        mobile,address, post_code, height, weight, birthday, blood, culture, finish_school_date," +
 8                         "        folk, government, homepage, householder, marriage, msn, nativity_address, qq, speciality," +
 9                         "        description, version");
10                 FROM("sys_user u");
11                 LEFT_OUTER_JOIN("sys_user_info t on u.id=t.id");
12                 WHERE("u.id=#{id}");
13             }
14         } .toString();
15     }
16 
17     @SelectProvider(type=sysUserDynaSqlProvider.class, method="findUserinfoByIdSql")
18     List<Map<String, String>> findUserinfoByIdSql(@Param("id") String id);
View Code

@InsertProvider

可以使用@InsertProvider注解创建动态的INSERT语句:

 1     public String insertUser(final sysUser sys_user)
 2     {
 3         return new SQL()
 4         {
 5             {
 6                 INSERT_INTO("sys_user");
 7                 if (sys_user.getId()!=null)
 8                 {
 9                     VALUES("id", "#{id}");
10                 }
11                 if (sys_user.getName() != null)
12                 {
13                     VALUES("name", "#{name}");
14                 }
15             }
16         } .toString();
17     }
18 
19  @InsertProvider(type = sysUserDynaSqlProvider.class, method = "insertUser")
20     int insertUser4(sysUser sysuser);
View Code

@UpdateProvider

可以通过@UpdateProvider注解创建动态的UPDATE语句：

 1     public String updateUser(final sysUser sys_user)
 2     {
 3         return new SQL()
 4         {
 5             {
 6                 UPDATE("sys_user");
 7                 if (sys_user.getName() != null)
 8                 {
 9                     SET("name = #{name}");
10                 }
11                 WHERE("id = #{id}");
12             }
13         } .toString();
14     }
15 
16     @InsertProvider(type = sysUserDynaSqlProvider.class, method = "updateUser")
17     int updateUser2(sysUser sysuser);
View Code

@DeleteProvider

可以使用@DeleteProvider注解创建动态的DELETE语句：

 1     public String deleteUser()
 2     {
 3         return new SQL()
 4         {
 5             {
 6                 DELETE_FROM("sys_user");
 7                 WHERE("id = #{id}");
 8             }
 9         } .toString();
10     }
11 
12     @DeleteProvider(type = sysUserDynaSqlProvider.class, method = "deleteUser")
13     int deleteUser2(@Param("id") String id);
View Code

GITHUB

github :  https://github.com/nbfujx/learn-java-demo/tree/master/Goku.MybatisDemo.Annotation

 

文章标签：
SQL
Java
mybatis
数据库连接
数据格式
关系型数据库
Oracle
数据库
XML
关键词：
MyBatis注解
MyBatis sql
MyBatis配置
MyBatis接口
SQL接口
nbfujx
目录
相关文章
热爱技术的小郑
|
4天前
|
SQL Java 测试技术
3、Mybatis-Plus 自定义sql语句
这篇文章介绍了如何在Mybatis-Plus框架中使用自定义SQL语句进行数据库操作。内容包括文档结构、编写mapper文件、mapper.xml文件的解释说明、在mapper接口中定义方法、在mapper.xml文件中实现接口方法的SQL语句，以及如何在单元测试中测试自定义的SQL语句，并展示了测试结果。
热爱技术的小郑
10 3
3、Mybatis-Plus 自定义sql语句
热爱技术的小郑
|
4天前
|
SQL Java 数据库
5、Mybatis-Plus 常用注解
这篇文章详细介绍了Mybatis-Plus中常用的注解，包括解决实体类与数据库表名不一致、字段不匹配的问题，主键生成策略的配置，以及逻辑删除的实现方法。
热爱技术的小郑
5 1
热爱技术的小郑
|
4天前
|
SQL Java 数据库
5、Mybatis-Plus 常用注解
这篇文章详细介绍了Mybatis-Plus中常用的注解，包括解决实体类与数据库表名不一致、字段不匹配的问题，主键生成策略的配置，以及逻辑删除的实现方法。
热爱技术的小郑
8 0
5、Mybatis-Plus 常用注解
热爱技术的小郑
|
6天前
|
SQL Java 数据库连接
后端框架的学习----mybatis框架（7、使用注解开发）
这篇文章讲述了如何使用MyBatis框架的注解方式进行开发，包括在接口上使用注解定义SQL语句，并通过动态代理实现对数据库的增删改查操作，同时强调了接口需要在核心配置文件中注册绑定。
热爱技术的小郑
14 1
小王老师呀
|
14天前
|
XML Java 数据库连接
MyBatis中的接口代理机制及其使用
【8月更文挑战第5天】MyBatis的接口代理机制是其核心功能之一，允许通过定义接口并在运行时生成代理对象来操作数据库。开发者声明一个带有`@Mapper`注解的接口，MyBatis则依据接口方法、映射配置（XML或注解）及数据库信息动态生成代理类。此机制分为四步：创建接口、配置映射文件或使用注解、最后在业务逻辑中注入并使用代理对象。这种方式简化了数据库操作，提高了代码的可读性和可维护性。例如，在电商系统中可通过`OrderMapper`处理订单数据，在社交应用中利用`MessageMapper`管理消息，实现高效且清晰的数据库交互。
小王老师呀
20 5
香吧香
|
23天前
|
SQL Java 数据库连接
idea中配置mybatis 映射文件模版及 mybatis plus 自定义sql
idea中配置mybatis 映射文件模版及 mybatis plus 自定义sql
香吧香
38 3
热爱技术的小郑
|
5天前
|
SQL Java 数据库连接
后端框架的学习----mybatis框架（7、使用注解开发）
这篇文章讲述了如何使用MyBatis框架的注解方式进行开发，包括在接口上使用注解定义SQL语句，并通过动态代理实现对数据库的增删改查操作，同时强调了接口需要在核心配置文件中注册绑定。
热爱技术的小郑
6 0
cafehaus
|
1月前
|
SQL Java 数据库连接
mybatis动态SQL常用语法总结
MyBatis 使用 OGNL 表达式语言处理动态SQL，如 `if` 标签进行条件判断，`choose`、`when`、`otherwise` 实现多条件选择，`where`、`set` 管理SQL关键字，`trim` 提供通用修剪功能，`foreach` 遍历集合数据。`sql` 和 `include` 用于代码重用，`selectKey` 处理插入后的返回值。参数传递支持匿名、具名、列表、Map、Java Bean和JSON方式。注意SQL转义及使用合适的jdbcType映射Java类型。
cafehaus
50 7
游客e4ooen74o6ems
|
22天前
|
SQL 存储 关系型数据库
SQL安装实战：从零开始，一步步掌握SQL数据库的安装与配置
配置SQL数据库以优化性能 安装完成后，接下来的任务是对SQL数据库进行必要的配置，以确保其能够顺利运行并满足你的性能需求。以下是一些关键的配置步骤：
游客e4ooen74o6ems
38 0
游客e4ooen74o6ems
|
22天前
|
SQL 存储 关系型数据库
SQL安装指南：一步步教你如何安装并配置SQL数据库
展望未来，随着技术的不断进步和应用场景的不断拓展，SQL数据库将继续发挥重要作用。同时，我们也需要不断学习和掌握新的数据库技术和工具，以适应不断变化的市场需求和技术挑战。希望本文能为你提供一个良好的起点，帮助你在SQL数据库的学习和实践之路上取得更大的进步。
游客e4ooen74o6ems
27 0

热门文章

最新文章

  • 1
    springboot+druid+mybatis plus的多数据源配置
  • 2
    SpringMvc+Spring+MyBatis 基于注解整合
  • 3
    还在使用MyBatis Generator？试试这个工具
  • 4
    spring boot2 整合（一）Mybatis （特别完整！）
  • 5
    Mybatis调用Mysql存储过程
  • 6
    MyBatis Plus 解决大数据量查询慢问题
  • 7
    JavaWeb用户登录注册实例（mybatis、maven、mysql、tomcat、servlet）
  • 8
    MyBatis 映射器
  • 9
    MyBatis Review——延时加载
  • 10
    Spring+SpringMVC +MyBatis整合配置文件案例
  • 1
    数据分享|SQL Server、Visual Studio、tableau对信贷风险数据ETL分析、数据立方体构建可视化
    57
  • 2
    如何避免SQL注入？
    52
  • 3
    MySQL SQL error: #1271 - Illegal mix of collations for operation ‘UNION‘
    72
  • 4
    利用 SQL 注入提取数据方法总结
    42
  • 5
    SQL 注入神器：jSQL Injection 保姆级教程
    186
  • 6
    DataWorks产品使用合集之DataWorks中，填写ODPS SQL任务中的参数和分区信息如何解决
    52
  • 7
    DataWorks产品使用合集之在DataWorks的数据开发模式中，在presql和postsql中支持执行多条SQL语句如何解决
    117
  • 8
    30个业务场景的SQL优化
    281
  • 9
    【MySQL】：探秘主流关系型数据库管理系统及SQL语言
    149
  • 10
    MaxCompute产品使用合集之大数据计算MaxCompute即使用相同的SQL语句在DataWorks和Tunnel上执行，结果却不同，如何解决
    37

    • 相关课程

    更多
  • SQL完全自学手册
  • SQL Server on Linux入门教程
  • SQL入门与实践
  • 数据库及SQL/MySQL基础
  • SQL进阶及查询
  • MyBatis持久层框架入门

    • 相关电子书

    更多
  • SQL Server云化思考与实践
  • SQL Server 2017
  • Java Spring Boot开发实战系列课程【第6讲】：Spring Boot 2.0实战MyBatis与优化(Java面试题)

    • 相关实验场景

    更多
  • SQL的增删改查及函数应用
  • PolarDB MySQL自动SQL限流
  • 如何开通SQL Server的专属集群
  • 使用DAS实现数据库自动SQL优化
  • 使用DAS实现数据库自动SQL限流
  • 一小时快速掌握 SQL 语法
    • 下一篇
    通义千问API入门教程