mybatis入“坑”第一步

IT皮皮蟹發表於2021-06-22
MyBatis

一、匯入座標

要想通過maven建立一個簡單的mybatis專案，首先需要的是要匯入相關的座標。需要匯入的座標如下：

<dependencies>
	<!--mysql驅動座標-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.46</version>
    </dependency>
    <!-- mybatis座標 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <!--單元測試座標-->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>
</dependencies>

建立實體類User和在資料庫中插入建立對應的user表。

二、配置mybatis的核心配置檔案mybtis-config.xml

建立mybatis-config.xml的配置檔案，用於配置連線資料庫和註冊Mapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <properties resource="db.properties" />

    <!--資料庫連線的環境配置-->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>

    <!--每一個Mapper.xml都需要在mybatis核心配置檔案中註冊-->
    <mappers>
        <mapper resource="com/wkx/dao/UserMapper.xml"/>
    </mappers>
</configuration>

①properties標籤：可以動態配置屬性。

可以全部在外部進行配置，如下：

<properties resource="db.properties" />

也可以在通過property標籤一部分在外部進行內部配置另一部分在內部進行配置(如下)，增加配置的靈活性。

<properties resource="db.properties">
    <property name="username" value="root"/>
    <property name="password" value="123456"/>
</properties>

②環境配置environments標籤：用於配置資料的環境。可配置多個資料庫環境，但是SqlSessionFactory只能選擇一個去使用。如下：

<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <property name="driver" value="${driver}"/>
            <property name="url" value="${url}"/>
            <property name="username" value="${username}"/>
            <property name="password" value="${password}"/>
        </dataSource>
    </environment>
    <environment id="test">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <property name="driver" value="${driver}"/>
            <property name="url" value="${url}"/>
            <property name="username" value="${username}"/>
            <property name="password" value="${password}"/>
        </dataSource>
    </environment>
</environments>

可以在不同的環境下切換不同的資料環境，只需要修改environments標籤中的default屬性對應不同環境下的id屬性，比如development和test不同的環境。

③對映器mappers：定義對映的路徑，告訴mybatis去哪裡找對應的語句。除了上述通過類路徑的資源引用方式，也可以通過其它的方式。比如通過包的形式將對映器介面全部註冊為對映器，如下：

<mappers>
  <package name="com.wkx.dao"/>
</mappers>

問題：Mapper.xml的配置檔案在mybatis核心配置檔案註冊時找不到對應Mapper.xml，是因為maven讀取配置檔案時只在resources的檔案目錄下尋找，所以需要在pom.xml檔案中配置過濾器。所以pom.xml中應該新增如下程式碼：

<!--在build中配置resources,來防止資源匯出失敗的原因-->
<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>true</filtering>
        </resource>

        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>true</filtering>
        </resource>
    </resources>
</build>

三、建立Mapper.xml

完成mybatis-config.xml配置檔案的建立後，接著需要配置相關的Mapper.xml，進而進行SQL語句的編寫。

<mapper namespace="com.wkx.dao.UserMapper">
    <select id="getUser" resultType="com.wkx.pojo.User">
        select * from user
    </select>

    <!--使用User類作為輸入型別-->
    <update id="updateUser" parameterType="com.wkx.pojo.User">
        update user set name=#{name},pwd=#{pwd} where id=#{id}
    </update>

    <!--map型別(只需要其中的key對應sql語句中的需要注入的值)-->
    <update id="updateUserMap" parameterType="map">
        update user set name=#{username} where id=#{uid}
    </update>
</mapper>

①namespace名稱空間：使用全限定類名對語句進行隔離，以及實現對介面的繫結。

②select、update等標籤中的id屬性對應的是Mapper介面中的方法名。通過id找到對應的方法需要執行的SQL語句。

③使用的Map集合型別對資料的SQL語句進行操作，只需要將Map集合中key對應SQL語句中的需要注入的值。也就是說SQL隱碼攻擊的值可以不和實體類中屬性一致。同時，使用Map集合而不是User類作為傳入型別進行傳輸時不需要將User類中所有資料傳輸。

四、編寫工具類

mybatis的使用需要以SqlSessionFactory為核心，使用SqlSessionFactory去生產SqlSession物件。建立一個工具類去生產SqlSession物件，以後使用mybatis便可以從該工具類中拿出SqlSession。

public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;

    // 呼叫該類執行該靜態模組中的程式碼，獲取SqlSessionFactory
    static {
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    // 通過該方法可以生產SqlSession物件
    public SqlSession getSqlSession(){
        SqlSession sqlSession = sqlSessionFactory.openSession();
        return sqlSession;
    }
}

五、測試

接著我們就可以利用mybatisUtils工具類生產的SqlSession物件去呼叫openSession執行對應的Mapper介面，就可以呼叫介面中的方法去執行對應的SQL語句。

具體測試類如下：

// 查詢所有使用者資訊
@Test
public void queryUserTest(){
    MybatisUtils mybatisUtils = new MybatisUtils();
    // 呼叫mybatisUtils中的getSqlSession方法獲取SqlSession物件
    SqlSession sqlSession = mybatisUtils.getSqlSession();
    // 執行SqlSession中的getMapper方法，以便後來來執行對應的Mapper介面方法
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);

    // 執行介面方法，配置完成mybatis會呼叫的對應的SQL語句執行
    List<User> user = mapper.getUser();
    sqlSession.close();
    System.out.println(user);
}

// 使用Map資料型別對資料進行更新
@Test
public void updateUserMap(){
    MybatisUtils mybatisUtils = new MybatisUtils();
    SqlSession sqlSession = mybatisUtils.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);

    Map<String,Object> map = new HashMap<>();

    map.put("username","王三");
    // map.put("password","2334op");
    map.put("uid","3");

    int count = mapper.updateUserMap(map);

    /*增刪改的資料庫操作需要提交事務*/
    sqlSession.commit();
    sqlSession.close();
    System.out.println(count);
}

注意：① 增刪改的SQL語句操作都需要進行事務的提交。
         ② SqlSession使用完後要記得關閉。

相關文章