【mybatis annotation】資料層框架應用--Mybatis（二）基於註解實現資料的CRUD

lomtom發表於2020-04-29

使用MyBatis框架進行持久層開發

MyBatis是支援普通SQL查詢，儲存過程和高階對映的優秀持久層框架。
MyBatis消除了幾乎所有的JDBC程式碼和引數的手工設定以及對結果集的檢索。
MyBatis可以使用簡單的XML或註解用於配置和原始對映，將介面和Java的POJO（Plain Old Java Objects，普通的Java物件）對映成資料庫中的記錄。
目錄
- 使用MyBatis框架進行持久層開發

你需要了解的知識點

1、什麼是SqlSessionFactory?

SqlSessionFactory是MyBatis框架中十分重要的物件，它是單個資料庫對映關係經過編譯後的記憶體映象，其主要作用是建立SqlSession。

SqlSessionFactory物件的例項可以通過SqlSessionFactoryBuilder物件來構建，而SqlSessionFactoryBuilder則可以通過XML配置檔案或一個預先定義好的Configuration例項構建出SqlSessionFactory的例項

SqlSessionFactory物件是執行緒安全的，它一旦被建立，在整個應用執行期間都會存在。如果我們多次的建立同一個資料庫的SqlSessionFactory，那麼此資料庫的資源將很容易被耗盡。為此，通常每一個資料庫都會只對應一個SqlSessionFactory，所以在構建SqlSessionFactory例項時，建議使用單列模式。

2、為什麼要使用註解版

相信同學們已經瞭解到，mybatis有xml版與註解版兩種形式，那我們實際開發中使用xml版還是註解版呢，我只能告訴你，兩種版本各有各的優點，可以根據自己的需求再不同的環境使用不同的方式。

1、註解版：簡單方便
2、xml版：可維護性高

使用

1、MyBatis下載

在Java或Java Web專案中新增MyBatis框架後，就能對資料表進行CRUD操作了。

方法一：可以從官方網站: https://github.com/mybatis下載所需要的MyBatis版本。

方法二：使用maven的直接加入依賴，需要MySQL的驅動包、mybatis的驅動包

        <!--        資料庫  start-->
        <!--        引入jdbc與mysql依賴-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.18</version>
        </dependency>
        <!--        mybatis-->
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        <!--        資料庫 end-->

注意這裡的mysql的驅動包，根據你自己安裝的mysql版本，使用mysql -V查詢，例如我的是8版本，所以用8版本的驅動包

2、建立實體類

在src目錄下新建com.lomtom.mybatis.entity包，並在其中建立實體類UserInfo（對應資料表user_info）。UserInfo類包含一些屬性（對應資料表user_info的部分欄位），以及與之對應的getXXX()和setXXX()方法，還可新增構造方法。

當然你如果使用lombok可以不寫他的getter、setter以及constructor。

/**
 * @Author: LOMTOM
 * @Date: 2020/4/20
 * @Time: 15:12
 * @Email: lomtom@qq.com
 */
@Data
public class UserInfo {

    private Integer id;

    private String userName;

    private String passWord;

    private Date regDate;

}

3、建立屬性檔案jdbc.properties

在resources目錄下建立屬性檔案jdbc.properties，儲存資料庫的連線資訊。

<properties>是一個配置屬性的元素，該元素通常用來將內部的配置外在化，即通過外部的配置來動態的替換內部定義的屬性。例如，資料庫的連線等屬性，就可以通過典型的Java屬性檔案中的配置來替換，

請根據自己mysql版本，確認之後再食用

1、mysql for version 8
jdbc.driverClassName=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/javaweb2?characterEncoding=UTF-8
jdbc.username=root
jdbc.password=123456

2、mysql for version 5
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/javaweb2?characterEncoding=UTF-8
jdbc.username=root
jdbc.password=123456

4、建立XML對映配置檔案

在resources目錄下建立MyBatis的XML配置檔案mybatis-config.xml，用於載入mysql的連線配置。

<configuration>
    <!--載入屬性檔案-->
    <properties resource="jdbc.properties"></properties>
    
    <!--給包中的類註冊別名,註冊後可以直接使用類名,而不用使用全限定的類名就是不用包含包名)。-->
    <typeAliases>
        <package name="com.lomtom.mybatis.entity"/>
    </typeAliases>
    
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driverClassName}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper class="com.lomtom.mybatis.mapper.UserInfoMapperAnnotation"></mapper>
    </mappers>
</configuration>

<typeAliases>元素用於為配置檔案中的Java型別設定一個簡短的名字，即設定別名。別名的設定與XML配置相關，其使用的意義在於減少全限定類名的冗餘。
當POJO類過多時可以指定一個包名，MyBatis 會在包名下面搜尋需要的 Java Bean。每一個在包中的 Java Bean，在沒有註解的情況下，會使用 Bean 的首字母小寫的非限定類名來作為它的別名。若有註解，則別名為其註解值
<environments>元素用於對環境進行配置。MyBatis的環境配置實際上就是資料來源的配置，我們可以通過<environments>元素配置多種資料來源，即配置多種資料庫。

5、建立Mapper介面

在com.lomtom.mybatis.mapper包中建立UserInfoMapperAnnotation.java介面，並且加入

testAddUserInfo()方法
testGetUserInfoById()方法
testGetAllUserInfo()方法
testUpdateUserInfo()方法
testDeleteUserInfo()方法

/**
 * @Author: LOMTOM
 * @Date: 2020/4/26
 * @Time: 16:16
 * @Email: lomtom@qq.com
 */
public interface UserInfoMapperAnnotation {

    /**
     * 插入
     * @param userInfo
     * @return
     */
    @Insert(" insert into user_info(userName, passWord, regDate)\n" +
            "        values(#{userName},#{passWord}, #{regDate})")
    int addUserInfo(UserInfo userInfo);

    /**
     * 刪除
     * @param id
     * @return
     */
    @Delete("delete from user_info where id = #{id}")
    int deleteUserInfo(Integer id);

    /**
     * 獲取
     * @param id
     * @return
     */
    @Select("select * from user_info where id = #{id}")
    UserInfo getUserInfoById(Integer id);

    /**
     * 獲取全部
     * @return
     */
    @Select("select * from user_info")
    List<UserInfo> getALLUserInfo();

    /**
     * 更新
     * @param userInfo
     * @return
     */
    @Update("update user_info set userName = #{userName}, passWord = #{passWord}, regDate = #{regDate} where id = #{id}")
    void updateUserInfo(UserInfo userInfo);
}

6、編寫mybatis工具類


/**
 * @Author: LOMTOM
 * @Date: 2020/4/20
 * @Time: 15:49
 * @Email: lomtom@qq.com
 */
public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory = null;
    static {
        try {
            Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
            sqlSessionFactory =  new SqlSessionFactoryBuilder().build(reader);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static SqlSession getSession() {
        return sqlSessionFactory.openSession();
    }
}

7、編寫測試類

首先，需要加入必不可少的依賴

        <!--        測試-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>

新建Test.java

/**
 * @Author: LOMTOM
 * @Date: 2020/4/20
 * @Time: 15:44
 * @Email: lomtom@qq.com
 */


public class MybatisTest {


    @Test
    public void testAddUserInfoAnnotation(){
        SqlSession sqlSession= MybatisUtils.getSession();
        UserInfoMapperAnnotation userInfoMapper = sqlSession.getMapper(UserInfoMapperAnnotation. class);
        UserInfo userInfo= new UserInfo();
        userInfo.setUserName("qq小冰");
        userInfo.setPassWord("123");
        userInfo.setRegDate(new Date());
        int i= userInfoMapper.addUserInfo(userInfo);
        System. out. println (i+ " record has inserted !");
        sqlSession.commit();
        sqlSession.close();
    }


    @Test
    public void testGetUserInfoByIdAnnotation(){
        SqlSession sqlSession= MybatisUtils.getSession();
        UserInfoMapperAnnotation userInfoMapper = sqlSession.getMapper(UserInfoMapperAnnotation. class);
        System.out.println(userInfoMapper.getUserInfoById(1));
        System. out. println ("record has got !");
        sqlSession.commit();
        sqlSession.close();
    }

    @Test
    public void testGetAllUserInfoAnnotation(){
        SqlSession sqlSession= MybatisUtils.getSession();
        UserInfoMapperAnnotation userInfoMapper = sqlSession.getMapper(UserInfoMapperAnnotation. class);
        System.out.println(userInfoMapper.getALLUserInfo());
        System. out. println ("record has got !");
        sqlSession.commit();
        sqlSession.close();
    }

    @Test
    public void testUpdateUserInfoAnnotation(){
        SqlSession sqlSession= MybatisUtils.getSession();
        UserInfoMapperAnnotation userInfoMapper = sqlSession.getMapper(UserInfoMapperAnnotation. class);
        UserInfo userInfo= new UserInfo();
        userInfo.setId(1);
        userInfo.setUserName("qq大冰");
        userInfo.setPassWord("123456");
        userInfo.setRegDate(new Date());
        try {
            userInfoMapper.updateUserInfo(userInfo);
            System. out. println ("record has updated !");
        }catch (Exception e){
            e.printStackTrace();
        }
        sqlSession.commit();
        sqlSession.close();
    }

    @Test
    public void testDeleteUserInfoAnnotation(){
        SqlSession sqlSession= MybatisUtils.getSession();
        UserInfoMapperAnnotation userInfoMapper = sqlSession.getMapper(UserInfoMapperAnnotation. class);
        int i= userInfoMapper.deleteUserInfo(1);
        System. out. println (i+ " record has deleted !");
        sqlSession.commit();
        sqlSession.close();
    }

你可能會出現的問題

問題一：mysql客戶端版本過低

描述：

MySQLNonTransientConnectionException: Client does not support authentication protocol requested by server; consider upgrading MySQL client

分析： 這是前面一直強調的mysql驅動包的，一定要根據自己的mysql版本匯入相應的mysql驅動包
解決： 我的是 version 8，而我用的是5的驅動包，更改驅動包後解決

寫在最後

關注公眾號：博奧思園 ，精彩內容不錯失

你的支援是作者最大的動力

【mybatis xml】資料層框架應用--Mybatis 基於XML對映檔案實現資料的CRUD
2020-04-24
MyBatisXML框架
基於註解的springboot+mybatis的多資料來源元件的實現
2021-04-15
Spring BootMyBatis元件
Mybatis相關：基於註解的Mybatis開發
2020-10-25
MyBatis
SpringBoot資料訪問之整合mybatis註解版
2021-08-28
Spring BootMyBatis
Mybatis實現分包定義資料庫
2022-01-09
MyBatis資料庫
MyBatis：使用MyBatis Generator快速完成Springboot專案資料層開發
2020-10-24
MyBatisSpring Boot
使用dbunit測試spring + mybatis的資料庫應用
2021-09-09
SpringMyBatis資料庫
mybatis怎麼實現insert into多個資料-oracle資料庫
2024-04-13
MyBatisOracle資料庫
GBASE資料實現資料層面同城雙活之應用
2022-03-30
mybatis實現MySQL資料庫的增刪改查
2020-12-29
MyBatisMySql資料庫
mybatis插入資料、批量插入資料
2021-12-08
MyBatis
MyBatis Java 和資料庫資料型別對應表
2024-03-07
MyBatisJava資料庫資料型別
mybatis 批次插入資料
2024-12-02
MyBatis
Mybatis 學習筆記（二）——原生DAO實現資料增刪改查
2018-10-13
MyBatis筆記
06_應用層和核心層實現資料互動
2024-04-22
使用Mybatis批量插入大量資料的實踐
2022-01-03
MyBatis
MyBatis攔截器優雅實現資料脫敏
2023-11-01
MyBatis
基於SpirngBoot2.0+ 的 SpringBoot+Mybatis 多資料來源配置
2018-12-05
Spring BootMyBatis
Mybatis資料庫驅動
2023-03-15
MyBatis資料庫
Mybatis連線資料庫
2023-02-26
MyBatis資料庫
Mybatis原始碼分析（二）XML的解析和Annotation的支援
2019-03-10
MyBatis原始碼XML
SpringBoot整合MyBatis-Plus實現多資料來源操作
2024-11-29
Spring BootMyBatis
Java 持久層框架之 MyBatis
2020-12-22
Java框架MyBatis
MyBatis-03(CRUD)
2020-10-26
MyBatis
Mybatis-02 CRUD
2021-02-17
MyBatis
Mybatis學習01：利用mybatis查詢資料庫
2021-06-23
MyBatis資料庫
基於"堆"的底層實現和應用
2019-03-09
Spring Boot入門(六)：使用MyBatis訪問MySql資料庫(註解方式)
2019-06-11
Spring BootMyBatisMySql資料庫
mybatis-plus原始碼解析(二)----基於@MapperScan註解掃描載入Mapper
2018-05-04
MyBatis原始碼APP
Springboot整合mybatis實現多資料來源所遇到的問題
2020-11-15
Spring BootMyBatis
Mybatis解決實體類屬性名與資料庫列名不對應的方法
2020-12-05
MyBatis資料庫
java-Mybatis 註解方式實現sql語句
2020-11-12
JavaMyBatisSQL
MyBatis--優秀的持久層框架
2018-07-16
MyBatis框架
MyBatis 的簡單 CRUD 操作
2020-06-19
MyBatis
Minya 分層框架實現的思考（二）：構建依賴及資料傳輸
2018-04-13
框架
Spring Boot 揭祕與實戰（二）資料儲存篇 – MyBatis整合
2019-03-04
Spring BootMyBatis
MyBatis-04-資料庫配置
2024-04-16
MyBatis資料庫
MyBatis整合雙資料來源
2020-06-04
MyBatis

【mybatis annotation】資料層框架應用--Mybatis（二） 基於註解實現資料的CRUD