当前位置: 移动技术网 > IT编程>开发语言>Java > Spring Boot(六):如何优雅的使用 Mybatis

Spring Boot(六):如何优雅的使用 Mybatis

2019年06月27日  | 移动技术网IT编程  | 我要评论

v

​这两天启动了一个新项目因为项目组成员一直都使用的是 mybatis,虽然个人比较喜欢 jpa 这种极简的模式,但是为了项目保持统一性技术选型还是定了 mybatis 。到网上找了一下关于 spring boot 和 mybatis 组合的相关资料,各种各样的形式都有,看的人心累,结合了 mybatis 的官方 demo 和文档终于找到了最简的两种模式,花了一天时间总结后分享出来。

orm 框架的本质是简化编程中操作数据库的编码,发展到现在基本上就剩两家了,一个是宣称可以不用写一句 sql 的 hibernate,一个是可以灵活调试动态 sql 的 mybatis ,两者各有特点,在企业级系统开发中可以根据需求灵活使用。发现一个有趣的现象:传统企业大都喜欢使用 hibernate ,互联网行业通常使用 mybatis 。

hibernate 特点就是所有的 sql 都用 java 代码来生成,不用跳出程序去写(看) sql ,有着编程的完整性,发展到最顶端就是 spring data jpa 这种模式了,基本上根据方法名就可以生成对应的 sql 了,有不太了解的可以看我的上篇文章springboot(五): spring data jpa 的使用。

mybatis 初期使用比较麻烦,需要各种配置文件、实体类、dao 层映射关联、还有一大推其它配置。当然 mybatis 也发现了这种弊端,初期开发了generator可以根据表结果自动生产实体类、配置文件和 dao 层代码,可以减轻一部分开发量;后期也进行了大量的优化可以使用注解了,自动管理 dao 层和配置文件等,发展到最顶端就是今天要讲的这种模式了, mybatis-spring-boot-starter 就是 spring boot+ mybatis 可以完全注解不用配置文件,也可以简单配置轻松上手。

现在想想 spring boot 就是牛逼呀,任何东西只要关联到 spring boot 都是化繁为简。

mybatis-spring-boot-starter

官方说明: mybatisspring-boot-starterwill help youusemybatiswithspringboot
其实就是 mybatis 看 spring boot 这么火热也开发出一套解决方案来凑凑热闹,但这一凑确实解决了很多问题,使用起来确实顺畅了许多。 mybatis-spring-boot-starter主要有两种解决方案,一种是使用注解解决一切问题,一种是简化后的老传统。

当然任何模式都需要首先引入 mybatis-spring-boot-starter的 pom 文件,现在最新版本是 2.0.0

  1. <dependency>

  2. <groupid>org.mybatis.spring.boot</groupid>

  3. <artifactid>mybatis-spring-boot-starter</artifactid>

  4. <version>2.0.0</version>

  5. </dependency>

好了下来分别介绍两种开发模式

无配置文件注解版

就是一切使用注解搞定。

1 添加相关 maven 文件

  1. <dependencies>

  2. <dependency>

  3. <groupid>org.springframework.boot</groupid>

  4. <artifactid>spring-boot-starter-web</artifactid>

  5. </dependency>

  6. <dependency>

  7. <groupid>org.mybatis.spring.boot</groupid>

  8. <artifactid>mybatis-spring-boot-starter</artifactid>

  9. <version>2.0.0</version>

  10. </dependency>

  11. <dependency>

  12. <groupid>mysql</groupid>

  13. <artifactid>mysql-connector-java</artifactid>

  14. </dependency>

  15. </dependencies>

完整的 pom 包这里就不贴了,大家直接看源码

2、 application.properties 添加相关配置

  1. mybatis.type-aliases-package=com.neo.model

  2.  

  3. spring.datasource.url=jdbc:mysql://localhost:3306/test?servertimezone=utc&useunicode=true&characterencoding=utf-8&usessl=true

  4. spring.datasource.username=root

  5. spring.datasource.password=root

  6. spring.datasource.driver-class-name=com.mysql.cj.jdbc.driver

spring boot 会自动加载 spring.datasource.* 相关配置,数据源就会自动注入到 sqlsessionfactory 中,sqlsessionfactory 会自动注入到 mapper 中,对了,你一切都不用管了,直接拿起来使用就行了。

在启动类中添加对 mapper 包扫描 @mapperscan

  1. @springbootapplication

  2. @mapperscan("com.neo.mapper")

  3. public class mybatisannotationapplication {

  4.  

  5. public static void main(string[] args) {

  6. springapplication.run(mybatisannotationapplication.class, args);

  7. }

  8. }

或者直接在 mapper 类上面添加注解 @mapper,建议使用上面那种,不然每个 mapper 加个注解也挺麻烦的

3、开发 mapper

第三步是最关键的一块, sql 生产都在这里

  1. public interface usermapper {

  2.  

  3. @select("select * from users")

  4. @results({

  5. @result(property = "usersex", column = "user_sex", javatype = usersexenum.class),

  6. @result(property = "nickname", column = "nick_name")

  7. })

  8. list<userentity> getall();

  9.  

  10. @select("select * from users where id = #{id}")

  11. @results({

  12. @result(property = "usersex", column = "user_sex", javatype = usersexenum.class),

  13. @result(property = "nickname", column = "nick_name")

  14. })

  15. userentity getone(long id);

  16.  

  17. @insert("insert into users(username,password,user_sex) values(#{username}, #{password}, #{usersex})")

  18. void insert(userentity user);

  19.  

  20. @update("update users set username=#{username},nick_name=#{nickname} where id =#{id}")

  21. void update(userentity user);

  22.  

  23. @delete("delete from users where id =#{id}")

  24. void delete(long id);

  25.  

  26. }

为了更接近生产我特地将usersex、nickname两个属性在数据库加了下划线和实体类属性名不一致,另外user_sex使用了枚举

  • @select 是查询类的注解,所有的查询均使用这个

  • @result 修饰返回的结果集,关联实体类属性和数据库字段一一对应,如果实体类属性和数据库属性名保持一致,就不需要这个属性来修饰。

  • @insert 插入数据库使用,直接传入实体类会自动解析属性到对应的值

  • @update 负责修改,也可以直接传入对象

  • @delete 负责删除

了解更多属性参考这里

注意,使用#符号和$符号的不同:

  1. // this example creates a prepared statement, something like select * from teacher where name = ?;

  2. @select("select * from teacher where name = #{name}")

  3. teacher selectteachforgivenname(@param("name") string name);

  4.  

  5. // this example creates n inlined statement, something like select * from teacher where name = 'somename';

  6. @select("select * from teacher where name = '${name}'")

  7. teacher selectteachforgivenname(@param("name") string name);

4、使用

上面三步就基本完成了相关 mapper 层开发,使用的时候当作普通的类注入进入就可以了

  1. @runwith(springrunner.class)

  2. @springboottest

  3. public class usermappertest {

  4.  

  5. @autowired

  6. private usermapper usermapper;

  7.  

  8. @test

  9. public void testinsert() throws exception {

  10. usermapper.insert(new user("aa1", "a123456", usersexenum.man));

  11. usermapper.insert(new user("bb1", "b123456", usersexenum.woman));

  12. usermapper.insert(new user("cc1", "b123456", usersexenum.woman));

  13.  

  14. assert.assertequals(3, usermapper.getall().size());

  15. }

  16.  

  17. @test

  18. public void testquery() throws exception {

  19. list<user> users = usermapper.getall();

  20. system.out.println(users.tostring());

  21. }

  22.  

  23.  

  24. @test

  25. public void testupdate() throws exception {

  26. user user = usermapper.getone(30l);

  27. system.out.println(user.tostring());

  28. user.setnickname("neo");

  29. usermapper.update(user);

  30. assert.asserttrue(("neo".equals(usermapper.getone(30l).getnickname())));

  31. }

  32. }

源码中 controller 层有完整的增删改查,这里就不贴了

极简 xml 版本

极简 xml 版本保持映射文件的老传统,接口层只需要定义空方法,系统会自动根据方法名在映射文件中找对应的 sql .

1、配置

pom 文件和上个版本一样,只是 application.properties新增以下配置

  1. mybatis.config-location=classpath:mybatis/mybatis-config.xml

  2. mybatis.mapper-locations=classpath:mybatis/mapper/*.xml

指定了 mybatis 基础配置文件和实体类映射文件的地址

mybatis-config.xml 配置

  1. <configuration>

  2. <typealiases>

  3. <typealias alias="integer" type="java.lang.integer" />

  4. <typealias alias="long" type="java.lang.long" />

  5. <typealias alias="hashmap" type="java.util.hashmap" />

  6. <typealias alias="linkedhashmap" type="java.util.linkedhashmap" />

  7. <typealias alias="arraylist" type="java.util.arraylist" />

  8. <typealias alias="linkedlist" type="java.util.linkedlist" />

  9. </typealiases>

  10. </configuration>

这里也可以添加一些 mybatis 基础的配置

2、添加 user 的映射文件

  1. <mapper namespace="com.neo.mapper.usermapper" >

  2. <resultmap id="baseresultmap" type="com.neo.entity.userentity" >

  3. <id column="id" property="id" jdbctype="bigint" />

  4. <result column="username" property="username" jdbctype="varchar" />

  5. <result column="password" property="password" jdbctype="varchar" />

  6. <result column="user_sex" property="usersex" javatype="com.neo.enums.usersexenum"/>

  7. <result column="nick_name" property="nickname" jdbctype="varchar" />

  8. </resultmap>

  9.  

  10. <sql id="base_column_list" >

  11. id, username, password, user_sex, nick_name

  12. </sql>

  13.  

  14. <select id="getall" resultmap="baseresultmap" >

  15. select

  16. <include refid="base_column_list" />

  17. from users

  18. </select>

  19.  

  20. <select id="getone" parametertype="java.lang.long" resultmap="baseresultmap" >

  21. select

  22. <include refid="base_column_list" />

  23. from users

  24. where id = #{id}

  25. </select>

  26.  

  27. <insert id="insert" parametertype="com.neo.entity.userentity" >

  28. insert into

  29. users

  30. (username,password,user_sex)

  31. values

  32. (#{username}, #{password}, #{usersex})

  33. </insert>

  34.  

  35. <update id="update" parametertype="com.neo.entity.userentity" >

  36. update

  37. users

  38. set

  39. <if test="username != null">username = #{username},</if>

  40. <if test="password != null">password = #{password},</if>

  41. nick_name = #{nickname}

  42. where

  43. id = #{id}

  44. </update>

  45.  

  46. <delete id="delete" parametertype="java.lang.long" >

  47. delete from

  48. users

  49. where

  50. id =#{id}

  51. </delete>

  52. </mapper>

其实就是把上个版本中 mapper 的 sql 搬到了这里的 xml 中了

3、编写 mapper 层的代码

  1. public interface usermapper {

  2.  

  3. list<userentity> getall();

  4.  

  5. userentity getone(long id);

  6.  

  7. void insert(userentity user);

  8.  

  9. void update(userentity user);

  10.  

  11. void delete(long id);

  12.  

  13. }

对比上一步,这里只需要定义接口方法

4、使用

使用和上个版本没有任何区别,大家就看文章对应的示例代码吧

如何选择

两种模式各有特点,注解版适合简单快速的模式,其实像现在流行的这种微服务模式,一个微服务就会对应一个自已的数据库,多表连接查询的需求会大大的降低,会越来越适合这种模式。

老传统模式比适合大型项目,可以灵活的动态生成 sql ,方便调整 sql ,也有痛痛快快,洋洋洒洒的写 sql 的感觉。

示例代码-https://github.com/ityouknow/spring-boot-examples/tree/master/spring-boot-mybatis

 

精彩回顾:

 

强烈推荐:

《java 极客技术》知识星球限时优惠,现在加入只需 50 元,仅限前 1000 名,机不可失时不再来。趁早行动吧!

https://t.zsxq.com/j6em2nu

 

隆重介绍:

java 极客技术公众号,是由一群热爱 java 开发的技术人组建成立,专注分享原创、高质量的 java 文章。如果您觉得我们的文章还不错,请帮忙赞赏、在看、转发支持,鼓励我们分享出更好的文章。

 

如对本文有疑问, 点击进行留言回复!!

相关文章:

验证码:
移动技术网