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

2021年09月15日 阅读数:5
这篇文章主要向大家介绍Spring Boot(六):如何优雅的使用 Mybatis,主要内容包括基础应用、实用技巧、原理机制等方面,希望对大家有所帮助。

这两天启动了一个新项目由于项目组成员一直都使用的是 Mybatis,虽然我的比较喜欢 Jpa 这种极简的模式,可是为了项目保持统一性技术选型仍是定了 Mybatis 。到网上找了一下关于 Spring Boot 和 Mybatis 组合的相关资料,各类各样的形式都有,看的人心累,结合了 Mybatis 的官方 Demo 和文档终于找到了最简的两种模式,花了一天时间总结后分享出来。java

Orm 框架的本质是简化编程中操做数据库的编码,发展到如今基本上就剩两家了,一个是宣称能够不用写一句 Sql 的 Hibernate,一个是能够灵活调试动态 Sql 的 Mybatis ,二者各有特色,在企业级系统开发中能够根据需求灵活使用。发现一个有趣的现象:传统企业大都喜欢使用 Hibernate ,互联网行业一般使用 Mybatis 。mysql

Hibernate 特色就是全部的 Sql 都用 Java 代码来生成,不用跳出程序去写(看) Sql ,有着编程的完整性,发展到最顶端就是 Spring Data Jpa 这种模式了,基本上根据方法名就能够生成对应的 Sql 了,有不太了解的能够看个人上篇文章springboot(五): Spring Data Jpa 的使用。git

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

如今想一想 Spring Boot 就是牛逼呀,任何东西只要关联到 Spring Boot 都是化繁为简。web

mybatis-spring-boot-starter

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

固然任何模式都须要首先引入 mybatis-spring-boot-starter的 Pom 文件,如今最新版本是 2.0.0sql

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.0.0</version>
</dependency>

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

无配置文件注解版

就是一切使用注解搞定。编程

1 添加相关 Maven 文件

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.0.0</version>
    </dependency>
     <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

完整的 Pom 包这里就不贴了,你们直接看源码springboot

二、 application.properties 添加相关配置

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


  2. spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true

  3. spring.datasource.username=root

  4. spring.datasource.password=root

  5. 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.    public static void main(String[] args) {

  5.        SpringApplication.run(MybatisAnnotationApplication.class, args);

  6.    }

  7. }

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

三、开发 Mapper

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

 
 
  1. public interface UserMapper {


  2.    @Select("SELECT * FROM users")

  3.    @Results({

  4.        @Result(property = "userSex",  column = "user_sex", javaType = UserSexEnum.class),

  5.        @Result(property = "nickName", column = "nick_name")

  6.    })

  7.    List<UserEntity> getAll();


  8.    @Select("SELECT * FROM users WHERE id = #{id}")

  9.    @Results({

  10.        @Result(property = "userSex",  column = "user_sex", javaType = UserSexEnum.class),

  11.        @Result(property = "nickName", column = "nick_name")

  12.    })

  13.    UserEntity getOne(Long id);


  14.    @Insert("INSERT INTO users(userName,passWord,user_sex) VALUES(#{userName}, #{passWord}, #{userSex})")

  15.    void insert(UserEntity user);


  16.    @Update("UPDATE users SET userName=#{userName},nick_name=#{nickName} WHERE id =#{id}")

  17.    void update(UserEntity user);


  18.    @Delete("DELETE FROM users WHERE id =#{id}")

  19.    void delete(Long id);


  20. }

为了更接近生产我特意将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. // This example creates n inlined statement, something like select * from teacher where name = 'someName';

  5. @Select("Select * from teacher where name = '${name}'")

  6. Teacher selectTeachForGivenName(@Param("name") String name);

四、使用

上面三步就基本完成了相关 Mapper 层开发,使用的时候看成普通的类注入进入就能够了

 
 
  1. @RunWith(SpringRunner.class)

  2. @SpringBootTest

  3. public class UserMapperTest {


  4.    @Autowired

  5.    private UserMapper userMapper;


  6.    @Test

  7.    public void testInsert() throws Exception {

  8.        userMapper.insert(new User("aa1", "a123456", UserSexEnum.MAN));

  9.        userMapper.insert(new User("bb1", "b123456", UserSexEnum.WOMAN));

  10.        userMapper.insert(new User("cc1", "b123456", UserSexEnum.WOMAN));


  11.        Assert.assertEquals(3, userMapper.getAll().size());

  12.    }


  13.    @Test

  14.    public void testQuery() throws Exception {

  15.        List<User> users = userMapper.getAll();

  16.        System.out.println(users.toString());

  17.    }



  18.    @Test

  19.    public void testUpdate() throws Exception {

  20.        User user = userMapper.getOne(30l);

  21.        System.out.println(user.toString());

  22.        user.setNickName("neo");

  23.        userMapper.update(user);

  24.        Assert.assertTrue(("neo".equals(userMapper.getOne(30l).getNickName())));

  25.    }

  26. }

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

极简 xml 版本

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

一、配置

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

mybatis.config-location=classpath:mybatis/mybatis-config.xml
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml

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

mybatis-config.xml 配置

<configuration>
    <typeAliases>
        <typeAlias alias="Integer" type="java.lang.Integer" />
        <typeAlias alias="Long" type="java.lang.Long" />
        <typeAlias alias="HashMap" type="java.util.HashMap" />
        <typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap" />
        <typeAlias alias="ArrayList" type="java.util.ArrayList" />
        <typeAlias alias="LinkedList" type="java.util.LinkedList" />
    </typeAliases>
</configuration>

这里也能够添加一些 Mybatis 基础的配置

二、添加 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.    <sql id="Base_Column_List" >

  10.        id, userName, passWord, user_sex, nick_name

  11.    </sql>


  12.    <select id="getAll" resultMap="BaseResultMap"  >

  13.       SELECT

  14.       <include refid="Base_Column_List" />

  15.       FROM users

  16.    </select>


  17.    <select id="getOne" parameterType="java.lang.Long" resultMap="BaseResultMap" >

  18.        SELECT

  19.       <include refid="Base_Column_List" />

  20.       FROM users

  21.       WHERE id = #{id}

  22.    </select>


  23.    <insert id="insert" parameterType="com.neo.entity.UserEntity" >

  24.       INSERT INTO

  25.               users

  26.               (userName,passWord,user_sex)

  27.           VALUES

  28.               (#{userName}, #{passWord}, #{userSex})

  29.    </insert>


  30.    <update id="update" parameterType="com.neo.entity.UserEntity" >

  31.       UPDATE

  32.               users

  33.       SET

  34.           <if test="userName != null">userName = #{userName},</if>

  35.           <if test="passWord != null">passWord = #{passWord},</if>

  36.           nick_name = #{nickName}

  37.       WHERE

  38.               id = #{id}

  39.    </update>


  40.    <delete id="delete" parameterType="java.lang.Long" >

  41.       DELETE FROM

  42.                users

  43.       WHERE

  44.                id =#{id}

  45.    </delete>

  46. </mapper>

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

三、编写 Mapper 层的代码

 
 
  1. public interface UserMapper {


  2.    List<UserEntity> getAll();


  3.    UserEntity getOne(Long id);


  4.    void insert(UserEntity user);


  5.    void update(UserEntity user);


  6.    void delete(Long id);


  7. }

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

四、使用

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

如何选择

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

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

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


-END-

https://mp.weixin.qq.com/s/75hvwguf6__A6bd2U2hrYw