乾貨Spring Boot系列:使用MyBatis

通過優銳課核心java學習筆記中,我們可以看到,MyBatis是用於高級映射和存儲過程的SQL框架。碼了很多專業的相關知識, 分享給大家參考學習。

MyBatis是一個SQL映射框架,支持自定義SQL,存儲過程和高級映射。
SpringBoot不爲MyBatis集成提供官方支持,但是MyBatis社區爲MyBatis構建了SpringBoot入門程序。

創建一個SpringBoot Maven項目並添加以下MyBatis Starter依賴項。


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

我們將重用在上一篇文章SpringBoot中創建的User.java,schema.sql和data.sql文件:使用JdbcTemplate

創建MyBatis SQL Mapper接口UserMapper.java,只需執行以下數據庫操作即可:

package com.sivalabs.demo.domain;
public interface UserMapper
{
    void insertUser(User user);
    User findUserById(Integer id);
    List<User> findAllUsers();
}

我們需要創建Mapper XML文件,以定義對應Mapper接口方法的映射SQL語句的查詢。

在src / main / resources / com / sivalabs / demo / mappers /目錄中創建UserMapper.xml文件,如下所示:

<!DOCTYPE mapper
    PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.sivalabs.demo.mappers.UserMapper">
    <resultMap id="UserResultMap" type="User">
        <id column="id" property="id" />
        <result column="name" property="name" />
        <result column="email" property="email" />
    </resultMap>
    <select id="findAllUsers" resultMap="UserResultMap">
        select id, name, email from users
    </select>
    <select id="findUserById" resultMap="UserResultMap">
        select id, name, email from users WHERE id=#{id}
    </select>
    <insert id="insertUser" parameterType="User" useGeneratedKeys="true" keyProperty="id">
        insert into users(name,email) values(#{name},#{email})
    </insert>
</mapper>

這裏要注意的幾件事是:

Mapper XML中的命名空間應與Mapper接口的完全限定名稱(FQN)相同
聲明ID值應與Mapper接口方法名稱相同。

如果查詢結果列名稱與bean屬性名稱不同,則可以使用配置在列名稱及其對應的bean屬性名稱之間提供映射。

MyBatis還提供基於註釋的查詢配置,而無需Mapper XML。

我們可以創建UserMapper.java接口並使用註釋配置映射的SQL,如下所示:

public interface UserMapper
{
    @Insert("insert into users(name,email) values(#{name},#{email})")
    @SelectKey(statement="call identity()", keyProperty="id",
    before=false, resultType=Integer.class)
    void insertUser(User user);
    @Select("select id, name, email from users WHERE id=#{id}")
    User findUserById(Integer id);
    @Select("select id, name, email from users")
    List<User> findAllUsers();
}

SpringBoot MyBatis入門程序提供以下MyBatis配置參數,我們可以使用這些參數自定義MyBatis設置。

mybatis.config = mybatis config file name
mybatis.mapperLocations = mappers file locations
mybatis.typeAliasesPackage = domain object's package
mybatis.typeHandlersPackage = handler's package
mybatis.check-config-location = check the mybatis configuration exists
mybatis.executorType = mode of execution. Default is SIMPLE

在application.properties中配置typeAliasesPackage和映射器位置。

mybatis.typeAliasesPackage=com.sivalabs.demo.domain
mybatis.mapperLocations=classpath*:**/mappers/*.xml

創建入口點類

SpringbootMyBatisDemoApplication.java。
@SpringBootApplication
@MapperScan("com.sivalabs.demo.mappers")
public class SpringbootMyBatisDemoApplication
{
    public static void main(String[] args)
    {
        SpringApplication.run(SpringbootMyBatisDemoApplication.class, args);
    }
}

觀察到我們已經使用@MapperScan(“ com.sivalabs.demo.mappers”)註釋指定在何處查找Mapper接口。

現在創建一個JUnit測試類並測試我們的UserMapper方法。

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(SpringbootMyBatisDemoApplication.class)
public class SpringbootMyBatisDemoApplicationTests
{
    @Autowired
    private UserMapper userMapper;
    @Test
    public void findAllUsers() {
        List<User> users = userMapper.findAllUsers();
        assertNotNull(users);
        assertTrue(!users.isEmpty());
    }
    @Test
    public void findUserById() {
        User user = userMapper.findUserById(1);
        assertNotNull(user);
    }
    @Test
    public void createUser() {
        User user = new User(0, "Siva", "[email protected]");
        userMapper.insertUser(user);
        User newUser = userMapper.findUserById(user.getId());
        assertEquals("Siva", newUser.getName());
        assertEquals("[email protected]", newUser.getEmail());
    }
}

你可以在http://www.mybatis.org/spring/上了解有關MyBatis和Spring集成的更多信息

文章寫到這裏,歡迎朋友們交流討論。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章