Spring Boot（5）—— Spring Boot中mybatis的使用

蔚落 2022-06-17 07:14 198阅读 0赞

**1、概述**

orm框架的本质是简化编程中操作数据库的编码，发展到现在目前应用比较多的有两个，一个是宣称可以不用写一句SQL的hibernate，一个是可以灵活调试动态sql的mybatis，两者各有特点，在开发中可以根据需求灵活使用。

hibernate特点就是所有的sql都用Java代码来生成，不用跳出程序去写sql，有着编程的完整性，发展到最顶端就是spring data jpa这种模式了，基本上根据方法名就可以生成对应的sql了。

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

mybatis官网：[http://www.mybatis.org/mybatis-3/zh/index.html][http_www.mybatis.org_mybatis-3_zh_index.html]

**2、mybatis-spring-boot-starter**

mybatis-spring-boot-starter主要有两种解决方案，一种是使用注解解决一切问题，一种是简化后的老传统。当然任何模式都需要首先引入mybatis-spring-boot-starter的pom文件：

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

下面来分别介绍两种开发模式。

**2.1 无配置文件注解版**

无配置文件注解模式就是使用注解搞定一切。

**（1）pom.xml配置**

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <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>1.1.1</version>
        </dependency>
         <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
         <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>

**（2）application.properties相关配置**

mybatis.type-aliases-package=com.demo.entity
    
    spring.datasource.test1.driverClassName = com.mysql.jdbc.Driver
    spring.datasource.test1.url = jdbc:mysql://localhost:3306/test1?useUnicode=true&characterEncoding=utf-8
    spring.datasource.test1.username = root
    spring.datasource.test1.password = root

springboot会自动加载spring.datasource.\*相关配置，数据源就会自动注入到sqlSessionFactory中，sqlSessionFactory会自动注入到Mapper中，然后你就都不用管了，直接拿起来使用就行了。

**（3）在启动类Application.java中添加对mapper包扫描@MapperScan**

@SpringBootApplication
    @MapperScan("com.demo.mapper")
    public class Application { 
    
        public static void main(String[] args) {
            SpringApplication.run(Application.class, args);
        }
    }

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

**（4）开发Mapper**

这是非常关键的一块，sql生产都在这里。User1Mapper.java

public interface User1Mapper {
    
        @Select("SELECT * FROM users")
        @Results({
            @Result(property = "userSex",  column = "user_sex", javaType = UserSexEnum.class),
            @Result(property = "nickName", column = "nick_name")
        })
        List<UserEntity> getAll();
    
        @Select("SELECT * FROM users WHERE id = #{id}")
        @Results({
            @Result(property = "userSex",  column = "user_sex", javaType = UserSexEnum.class),
            @Result(property = "nickName", column = "nick_name")
        })
        UserEntity getOne(Long id);
    
        @Insert("INSERT INTO users(userName,passWord,user_sex) VALUES(#{userName}, #{passWord}, #{userSex})")
        void insert(UserEntity user);
    
        @Update("UPDATE users SET userName=#{userName},nick_name=#{nickName} WHERE id =#{id}")
        void update(UserEntity user);
    
        @Delete("DELETE FROM users WHERE id =#{id}")
        void delete(Long id);
    
    }

为了更接近生产，特地将user\_sex、nick\_name两个属性在数据库加了下划线和实体类属性名不一致，另外user\_sex使用了枚举。说明：

@Select //是查询类的注解，所有的查询均使用这个
    @Result //修饰返回的结果集，关联实体类属性和数据库字段一一对应，如果实体类属性和数据库属性名保持一致，就不需要这个属性来修饰
    @Insert //插入数据库使用，直接传入实体类会自动解析属性到对应的值
    @Update //负责修改，也可以直接传入对象
    @delete //负责删除

更多关于mybatis属性请查阅：[http://www.mybatis.org/mybatis-3/zh/java-api.html][http_www.mybatis.org_mybatis-3_zh_java-api.html]

**注意**，使用\#符号和$符号的不同：

// This example creates a prepared statement, something like select * from teacher where name = ?;
    @Select("Select * from teacher where name = #{name}") Teacher selectTeachForGivenName(@Param("name") String name);
    
    // This example creates n inlined statement, something like select * from teacher where name = 'someName';
    @Select("Select * from teacher where name = '${name}'") Teacher selectTeachForGivenName(@Param("name") String name);

**（5）使用**

上面几步就基本完成了相关dao层开发，然后使用的时候当作普通的类注入进入就可以了。

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class User1MapperTest { 
    
        @Autowired
        private User1Mapper userMapper;
    
        @Test
        public void testInsert() throws Exception {
            userMapper.insert(new UserEntity("aa", "a123456", UserSexEnum.MAN));
            userMapper.insert(new UserEntity("bb", "b123456", UserSexEnum.WOMAN));
            userMapper.insert(new UserEntity("cc", "b123456", UserSexEnum.WOMAN));
    
            Assert.assertEquals(3, userMapper.getAll().size());
        }
    
        @Test
        public void testQuery() throws Exception {
            List<UserEntity> users = userMapper.getAll();
            if(users==null || users.size()==0){
                System.out.println("is null");
            }else{
                System.out.println(users.size());
            }
        }
    
    
        @Test
        public void testUpdate() throws Exception {
            UserEntity user = userMapper.getOne(6l);
            System.out.println(user.toString());
            user.setNickName("neo");
            userMapper.update(user);
            Assert.assertTrue(("neo".equals(userMapper.getOne(6l).getNickName())));
        }
    }

**2.2 极简xml版本**

极简xml版本保持映射文件的老传统，优化主要体现在不需要实现dao的是实现层，系统会自动根据方法名在映射文件中找对应的sql。

**（1）application.properties配置**

pom文件和上个版本一样，application.properties新增以下配置：

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

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

**（2）mybatis-config.xml 配置**

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

**（3）添加User的映射文件UserMapper.xml**

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    <mapper namespace="com.demo.mapper.UserMapper" >
        <resultMap id="BaseResultMap" type="com.demo.entity.UserEntity" >
            <id column="id" property="id" jdbcType="BIGINT" />
            <result column="userName" property="userName" jdbcType="VARCHAR" />
            <result column="passWord" property="passWord" jdbcType="VARCHAR" />
            <result column="user_sex" property="userSex" javaType="com.demo.enums.UserSexEnum"/>
            <result column="nick_name" property="nickName" jdbcType="VARCHAR" />
        </resultMap>
    
        <sql id="Base_Column_List" >
            id, userName, passWord, user_sex, nick_name
        </sql>
    
        <select id="getAll" resultMap="BaseResultMap" >
           SELECT 
           <include refid="Base_Column_List" />
           FROM users
        </select>
    
        <select id="getOne" parameterType="java.lang.Long" resultMap="BaseResultMap" >
            SELECT 
           <include refid="Base_Column_List" />
           FROM users
           WHERE id = #{id}
        </select>
    
        <insert id="insert" parameterType="com.demo.entity.UserEntity" >
           INSERT INTO 
                users
                (userName,passWord,user_sex) 
            VALUES
                (#{userName}, #{passWord}, #{userSex})
        </insert>
    
        <update id="update" parameterType="com.demo.entity.UserEntity" >
           UPDATE 
                users 
           SET 
            <if test="userName != null">userName = #{userName},</if>
            <if test="passWord != null">passWord = #{passWord},</if>
            nick_name = #{nickName}
           WHERE 
                id = #{id}
        </update>
    
        <delete id="delete" parameterType="java.lang.Long" >
           DELETE FROM
                 users 
           WHERE 
                 id =#{id}
        </delete>
    
    </mapper>

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

**（4）编写Dao层UserMapper.java代码**

public interface UserMapper {
    
        List<UserEntity> getAll();
    
        UserEntity getOne(Long id);
    
        void insert(UserEntity user);
    
        void update(UserEntity user);
    
        void delete(Long id);
    
    }

对比上一步这里全部只剩了接口方法.

**（5）使用**

使用和上个版本没有任何区别，UserMapperTest.java

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class UserMapperTest { 
    
        @Autowired
        private com.demo.mapper.UserMapper UserMapper;
    
        @Test
        public void testInsert() throws Exception {
            UserMapper.insert(new UserEntity("aa", "a123456", UserSexEnum.MAN));
            UserMapper.insert(new UserEntity("bb", "b123456", UserSexEnum.WOMAN));
            UserMapper.insert(new UserEntity("cc", "b123456", UserSexEnum.WOMAN));
    
            Assert.assertEquals(3, UserMapper.getAll().size());
        }
    
        @Test
        public void testQuery() throws Exception {
            List<UserEntity> users = UserMapper.getAll();
            if(users==null || users.size()==0){
                System.out.println("is null");
            }else{
                System.out.println(users.toString());
            }
        }
    
    
        @Test
        public void testUpdate() throws Exception {
            UserEntity user = UserMapper.getOne(6l);
            System.out.println(user.toString());
            user.setNickName("neo");
            UserMapper.update(user);
            Assert.assertTrue(("neo".equals(UserMapper.getOne(6l).getNickName())));
        }
    
    }

[http_www.mybatis.org_mybatis-3_zh_index.html]: http://www.mybatis.org/mybatis-3/zh/index.html
[http_www.mybatis.org_mybatis-3_zh_java-api.html]: http://www.mybatis.org/mybatis-3/zh/java-api.html