2. 程式人生 > >MyBatis 註解開發+逆向(Generator)

MyBatis 註解開發+逆向(Generator)

阿新 • • 發佈：2020-01-02

註解開發

最初設計時，MyBatis 是一個 XML 驅動的框架。配置資訊是基於 XML 的，而且對映語句也是定義在 XML 中的。隨著技術的更新發展,對於開發效率要求也原來越高,特別是一些小型專案;越來越多的框架開始支援註解,

到MyBatis3時,MyBatis對註解有了完善的支援,利用註解可以在一些情況下提高開發效率

但不幸的是，Java 註解的的表達力和靈活性十分有限。儘管很多時間都花在調查、設計和試驗上， 最強大的 MyBatis 對映並不能用註解來構建

1. select

介面方法宣告:

import com.kkb.pojo.User;
import org.apache.ibatis.annotations.Select;

public interface UserMapper2 {
    @Select("select * from kuser where id = #{id}")
    public User selectUserByID(int id);
}

測試方法:

@Test
public void selectTest(){
    SqlSession session = factory.openSession();
    UserMapper2 mapper = session.getMapper(UserMapper2.class);
    User user = mapper.selectUserByID(2);
    System.out.println(user);
    session.close();
}

不要忘記註冊這個介面到全域性配置中

<mappers>
    <mapper class="com.kkb.mapper.UserMapper2"/>
</mappers>

2. sql語句多個引數

介面方法宣告:

@Select("select * from kuser where sex = #{sex} and name like '%${name}%'")
public List<User> selectUserBySexAndName(@Param("sex") String sex, @Param("name") String name);

測試方法:

@Test
public void selectTest2(){
    SqlSession session = factory.openSession();
    UserMapper2 mapper = session.getMapper(UserMapper2.class);
    List<User> users = mapper.selectUserBySexAndName("1","張");
    System.out.println(users);
    session.close();
}

一定要記住MyBatis的sql接受的引數只有一個無論實際傳了幾個

當sql語句需要多個引數時則必須將多個引數打包到一個物件中,通常是POJO或Map,上面的案例中使用了@Param註解本質就是告訴MyBatis有多個引數MyBatis會自動建立一個Map,然後將@Param的值作為Key,然後將Map傳給sql,所以你也可以手動傳一個Map

介面方法宣告:

@Select("select * from kuser where sex = #{sex} and name like '%${name}%'")
public List<User> selectUserBySexAndName(Map<String,Object> params);

測試方法:

@Test
public void selectTest2(){
    SqlSession session = factory.openSession();
    UserMapper2 mapper = session.getMapper(UserMapper2.class);
    Map<String,Object> params = new HashMap<>(); //儲存引數的Map
    params.put("sex","1");
    params.put("name","張");
    List<User> users = mapper.selectUserBySexAndName(params);
    System.out.println(users);
    session.close();
}

3. insert

介面方法宣告:

@Insert("insert into kuser values(null,#{name},#{birthday},#{sex},#{address})")
public int insertUser(User user);

測試方法:

@Test
public void insertTest() {
    SqlSession session = factory.openSession();
    UserMapper2 mapper = session.getMapper(UserMapper2.class);
    
    User user = new User();
    user.setName("jerry");
    user.setSex("1");
    user.setAddress("亞洲中國");
    user.setBirthday(new Date());
    
    mapper.insertUser(user);
    session.commit();
    session.close();
}

獲取自增主鍵

在@select註解的下方新增@selectKey註解來完成對自增主鍵的獲取

@Insert("insert into kuser values(null,#{name},#{birthday},#{sex},#{address})")
@SelectKey(statement = "select last_insert_id()",keyProperty = "id",resultType = Integer.class,before = false)
public int insertUser(User user);

在執行insert之後執行last_insert_id()函式獲取自增值,然後放入物件的某個屬性中;

4. update

介面方法宣告:

@Update("update kuser set name = #{name}, birthday = #{birthday}, sex = #{sex}, address = #{address} where id = #{id}")
public int updateUser(User u);
// 如果一行太長可以換行些 但是要注意sql語法

測試方法:

@Test
public void updateTest() {
    SqlSession session = factory.openSession();
    UserMapper2 mapper = session.getMapper(UserMapper2.class);

    User user = mapper.selectUserByID(1);
    user.setName("王六子");

    mapper.updateUser(user);
    session.commit();
    session.close();
}

5.delete

介面方法宣告:

@Delete("delete from kuser where id = #{id}")
public int deleteUserByID(int id);

測試方法:

@Test
public void deleteTest() {
    SqlSession session = factory.openSession();
    UserMapper2 mapper = session.getMapper(UserMapper2.class);
    mapper.deleteUserByID(12);
    session.commit();
    session.close();
}

6. 動態sql

動態sql指語句中包含邏輯程式碼,需要先執行邏輯程式碼,最後產生sql語句,所以需要在註解中告訴MyBatis這是一個動態sql,通過<script>sql....</script>語法來指定;

若想要在sql中使用各種標籤則必須新增上述根標籤,否則MyBatis會將整體作為sql語句

介面方法宣告:

@Select("<script>" +
            "select * from kuser" +
            "<where>" +
                "<if test='name != null'>" +
                    "and name like '%${name}%'" +
                "</if>" +
                "<if test='sex != null'>" +
                    "and sex = #{sex}" +
                "</if>" +
            "</where>" +
        "</script>")
public List<User> searchUserByNameAndSex(@Param("name") String name,@Param("sex") String sex);

測試程式碼:

 @Test
    public void dynamicSqlTest(){
        SqlSession session = factory.openSession();
        UserMapper2 mapper = session.getMapper(UserMapper2.class);
        List<User> users = mapper.searchUserByNameAndSex(null,null);
//        List<User> users = mapper.searchUserByNameAndSex("張",null);
//        List<User> users = mapper.searchUserByNameAndSex("張", "2");
        System.out.println(users);
        session.close();
    }

7.結果對映(ResultMap)

1.自定義欄位與屬性對應關係

準備工作:將資料庫中的name欄位修改為username,然後我們通過ResultMap來手動對映name欄位

介面方法宣告:

@Select("select *from kuser where username = #{name}")
@Results({
        @Result(id = true,column = "id",property = "id"),
        @Result(column = "username",property = "name"),
})
public User selectUserByName(String name);

測試程式碼省略..

重複使用Results

可以發現,MyBatis預設會自動對映所有欄位和屬性匹配的資料,另外id表示是否為主鍵欄位,預設為false

強調:Results可以位於對應方法的上面或下面,但是無法跨域其他方法,預設只對當前方法有效,如果需要重複使用則需要為其指定id

介面方法宣告:

//定義
@Results(id="map1",value = {
        @Result(id = true,column = "id",property = "id"),
        @Result(column = "username",property = "name"),
})
//.....中間必須間隔其他方法不能立即應用到某個ResultMap

使用:

@Select("select *from kuser where username = #{name}")
//通過@ResultMap註解 並傳入id來使用
@ResultMap("map1")
public User selectUserByName(String name);

注意:@Results的定義不能不能和使用它的@ResultMap一起出現,既然是重複使用的那我建議統一介面的最上面

2.關聯查詢

一對多關聯

//實現根據使用者姓名查詢使用者資訊和訂單資訊
@Select("select *from kuser where username = #{name}")
@Results(value = {
        @Result(id = true,column = "id",property = "id"),
        @Result(column = "username",property = "name"),
        //一對多關聯,指定子查詢語句的方法名稱(全限定名稱)column指定傳給子查詢的引數
        @Result(column = "id",property = "orders",many = @Many(select = "com.kkb.mapper.UserMapper2.selectOrdersByID")),
})
public User selectUserAdnOrdersByUserName(String name);


//注意這裡的條件欄位時order表中的欄位
@Select("select *from Orders where user_id = #{id}")
public List<Order> selectOrdersByID(int id);

一對一關聯 只需要修改屬性名稱和註解名稱即可:

 @Select("select *from orders where id = #{id}")
    @Results(value = {
            @Result(id = true,column = "id",property = "id"),
            @Result(column = "user_id",property = "user" ,one = @One(select = "com.kkb.mapper.UserMapper2.selectUserByID")),
    })
    public Order selectOrderByID(int id);

逆向工程(generator)

generator翻譯為生成器,是MyBatis開源的一個外掛,可以從資料庫獲取表資訊,自動生成Mapper.xml,POJO,以及Mapper介面

但問題是,MyBatis不可能完全清楚我們的業務需求,所以其自動生成的sql只能滿足基本的CRUD操作,而無法幫助我們進行連表操作,(當然包括帶有條件的CRUD)

使用步驟

1.使用Maven新增generator外掛

<build>
    <plugins>
      <plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.7</version>
          <configuration>
                    <!-- 是否覆蓋已存在的介面和POJO-->
                <overwrite>true</overwrite>
        </configuration>
        </plugin>
    </plugins>
</build>

2.建立配置檔案,位於resource下名為generatorConfig.xml

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
    <!--匯入屬性配置-->
    <properties resource="jdbc.properties"></properties>
    <!--指定特定資料庫的jdbc驅動jar包的位置-->
    <classPathEntry location="${location}"/>
    <context id="default" targetRuntime="MyBatis3">
        <!-- optional，旨在建立class時，對註釋進行控制 -->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!--jdbc的資料庫連線 -->
        <jdbcConnection
                driverClass="${driver}" connectionURL="${url}" userId="${user}" password="${password}">
        </jdbcConnection>

        <!-- 非必需，型別處理器，在資料庫型別和java型別之間的轉換控制-->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!--Model模型生成器,用來生成含有主鍵key的類，記錄類 以及查詢Example類
        targetPackage 指定生成的model生成所在的包名
        targetProject 指定在該專案下所在的路徑 -->
        <javaModelGenerator targetPackage="com.kaikeba.pojo" targetProject="src/main/java">
            <!-- 是否允許子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否對model新增 建構函式 -->
            <property name="constructorBased" value="true"/>
            <!-- 是否對類CHAR型別的列的資料進行trim操作 -->
            <property name="trimStrings" value="true"/>
            <!-- 建立的Model物件是否 不可改變 即生成的Model物件不會有 setter方法，只有構造方法 -->
            <property name="immutable" value="false"/>
         </javaModelGenerator>

        <!--mapper對映檔案生成所在的目錄 為每一個數據庫的表生成對應的SqlMap檔案 -->
        <sqlMapGenerator targetPackage="com.kaikeba.dao"
                         targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!--mapper介面檔案生成所在的目錄 為每一個數據庫的表生成對應的介面檔案 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.kaikeba.dao" targetProject="src/main/java">
            <!-- enableSubPackages:是否讓schema(資料庫名稱)作為包的字尾 -->
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>


        <!--指定需要生成的表-->
        <table  tableName="category"></table>
        <table  tableName="orders"></table>
        <table  tableName="products"></table>
        <table  tableName="kuser"></table>
    </context>
</generatorConfiguration>

上述配置是一個較為通用的配置,實際開發中要根據需求進行修改
若自定義配置檔名稱則需要在pom中指定

<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <configuration>
                <!-- 自定義配置檔案 相對於專案根目錄-->
                <configurationFile>src/main/resources/aaaa.xml</configurationFile>
                <overwrite>true</overwrite>
            </configuration>
        </plugin>
    </plugins>
</build>

3.執行generator

可在idea右側的maven選單中雙擊執行mybatis-generator:generate

也可利用maven命令執行:mybatis-generator:generate

4.條件查詢的使用檢視POJO包,會發現每個POJO對應了一個Example,這是什麼呢?

generator的目標是儘可能的幫我們減少sql的編寫,如果只能進行簡單的CRUD那意義不大,於是generator使用了一套Example來幫助我們用OOP(面向物件)的方式來完成SQL中的條件拼接

其設計思想是將條件看做是一個物件,該物件包含了SQL中常見的比較,邏輯運算等......開啟檔案你會發現其本質就是幫我們拼接響應的sql符號和關鍵字

5.CRUD案例

import com.kaikeba.dao.KuserMapper;
import com.kaikeba.pojo.Kuser;
import com.kaikeba.pojo.KuserExample;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

public class GeneratorTest {
    private SqlSessionFactory factory;

    @Before
    public void init() throws IOException {
        //獲取的工廠構造器
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        //載入配置檔案
        InputStream stream = Resources.getResourceAsStream("mybatis-config.xml");
        //獲得會話工廠
        factory = builder.build(stream);
    }
    //查詢
    @Test
    public void test(){
        SqlSession session = factory.openSession();
        KuserMapper mapper = session.getMapper(KuserMapper.class);
        Kuser kuser = mapper.selectByPrimaryKey(1);
        System.out.println(kuser.getSex());
        System.out.println(kuser.getAddress());
        System.out.println(kuser.getBirthday());
        System.out.println(kuser.getUsername());
    }
    //修改
    @Test
    public void test2(){
        SqlSession session = factory.openSession();
        KuserMapper mapper = session.getMapper(KuserMapper.class);
        Kuser kuser = mapper.selectByPrimaryKey(1);
        kuser.setUsername("XXXXXXXXX");
        mapper.updateByPrimaryKey(kuser);
        session.commit();
    }
    //新增
    @Test
    public void test3(){
        SqlSession session = factory.openSession();
        KuserMapper mapper = session.getMapper(KuserMapper.class);
        Kuser auser = new Kuser();
        auser.setUsername("jack");
        auser.setAddress("北京東城");
        mapper.insert(auser);
        session.commit();
        }

    //刪除
    @Test
    public void test4() {
        SqlSession session = factory.openSession();
        KuserMapper mapper = session.getMapper(KuserMapper.class);
        mapper.deleteByPrimaryKey(13);
        session.commit();
    }
    //and條件
    @Test
    public void test5() {
        SqlSession session = factory.openSession();
        KuserMapper mapper = session.getMapper(KuserMapper.class);
        KuserExample kuserExample = new KuserExample();

        KuserExample.Criteria criteria = kuserExample.createCriteria();
        criteria.andBirthdayIsNotNull();
        criteria.andUsernameLike("%張%");

        List<Kuser> kusers = mapper.selectByExample(kuserExample);
        System.out.println(kusers);
    }
    // or條件
    @Test
    public void test6() {
        SqlSession session = factory.openSession();
        KuserMapper mapper = session.getMapper(KuserMapper.class);
        KuserExample kuserExample = new KuserExample();
        //建立一個條件物件,可以包含n個and
        KuserExample.Criteria criteria1 = kuserExample.createCriteria();
        criteria1.andUsernameLike("%張%");
        //建立一個條件物件可以包含n個and,且前面新增or關鍵字
        KuserExample.Criteria criteria2 = kuserExample.or();
        criteria2.andBirthdayIsNull();
        //最終的意思是 名字帶有張的 或者生日為空的;  具體邏輯可根據生產的sql進行分析
      
        List<Kuser> kusers = mapper.selectByExample(kuserExample);
        System.out.println(kusers);
    }  
}

相關推薦

MyBatis 註解開發+逆向(Generator)

註解開發 最初設計時，MyBatis 是一個 XML 驅動的框架。配置資訊是基於 XML 的，而且對映語句也是定義在 XML 中的。隨著技術的更新發展,對於開發效率要求也原來越高,特別是一些小型專案;越來越多的框架開始支援註解, 到MyBatis3時,MyBatis對註解有了完善的支援,利用註解可以在一些情況

mybatis註解開發，動態sql

sele sel myba 開始 xls inorder from all nbsp 在利用mybatis註解開始時，如果沒有用到動態sql時，可以直接寫 @Select("select * from order") List<XlSubOrder> getA

mybatis註解開發-動態SQL

sql語句 com jdbc new info ets stat -- -s 實體類以及表結構 在mybatis-config.xml中註冊mapper接口 -------------------------- 動態查詢@SelectProvider Emp

解決mybatis註解開發時兩表在一個方法裡面新增，一個表自動生成的主鍵作為另一個表的外來鍵新增的問題

1、mapper層裡的方法上添加註解： 實體類屬性：cExperimentaltaskid（id） 表字段：c_experimentaltaskid（主鍵id欄位） @Options(useGeneratedKeys = true, keyProperty = "cExperimentalta

Mybatis 註解開發傳入List 兩種方式接收方式 在IN場景中

1.在@Select中 @Select("<script>"               + "SELECT IDFA FROM t_xxx WHERE

MyBatis註解開發中傳多參問題

在Mybatis中使用註解開發時傳入多參會遇到這樣的錯誤： 程式碼如下： //介面程式碼 /** * 模糊查詢 * @param name * @return */ @Select("select * from user where

mybatis註解開發

  MyBatis可以利用SQL對映檔案來配置，也可以利用Annotation來設定。MyBatis提供的一些基本註解如下表所示。   註解 目標 相應的XML

Mybatis註解開發之動態SQL通過類方法註解

之前是xml和直接在mapper方法上面寫sql，發現太麻煩了，然後上網查了一下發現個好玩的方法，就是通過類的方法來註解開發（才開始學習寫部落格，有問題煩請多擔待）後續將繼續更新，更新完畢後將取消這段說明文字 1.寫對應的動態sql的類和相應方法(這裡我因為馬虎了，踩了大半

06 mybatis註解開發

  mybatis常用註解： @Insert:實現新增 @Update:實現更新 @Delete:實現刪除 @Select:實現查詢 @Result:實現結果集封裝 @Results:可以與@Result 一起使用，封裝多個結果集 @ResultMap:實

springboot整合mybatis註解開發，thymeleaf的簡單使用

1、前言 之前玩過使用xml配置檔案整合mybatis，這次為了整合thymeleaf模板，選用簡單的註解完成資料庫的查詢。整合工具無非是引入依賴，新增配置完成此相關功能。玩過之後，記錄一下學習的過程，以備後續使用。 2、依賴引入 使用springboot開發，建議裝上springboo

Mybatis註解開發之@Insert 與 @InsertProvider

1、專案主要結構：（1）專案中的實體類（2）每個實體類對應的Mapper方法（3）SQL工廠2、下面以BlogMapper中的儲存Blog實體方法為例：Blog實體類屬性：為了方便說明，屬性不設定過多，假設Blog類的屬性有blogId，title，author（1）@Insert的註解方式@Insert("

Mybatis註解開發案例（入門）

1、建立maven工程，配置pom.xml 檔案。   2、建立實體類     3、建立dao介面    4、建立主配置檔案SqlMapConfig.xml    5、在SqlMapConfig.xml中匯入外部配置檔

mybatis使用註解開發

plugins state let fig href ons class pub model 閱讀該篇文章將默認您已經能夠熟練使用mybatis配置mapper.xml進行開發了。首先把pom.xml貼出來吧。裏面有註釋 <project xmlns="

Java框架-mybatis延遲載入、快取和註解開發

1. 延遲載入 1.1 概念 在需要用到資料時才進行載入，不需要用到資料時就不載入資料。也稱作懶載入 好處：先從單表查詢，需要時再從關聯表去關聯查詢，大大提高資料庫效能 缺點：在大批量資料查詢時，由於查詢會耗時，可能導致使用者等待時間變長，影響使用者體驗

Spring Boot中使用MyBatis註解配置開發詳解

Spring Boot中使用MyBatis註解配置詳解 原創   2018-04-03 宗野       Spring Boot 最近專案原因可能會繼續開始使用

spring boot整合mybatis基於註解開發以及動態sql的使用

　　讓我們回憶一下上篇部落格中mybatis是怎樣發揮它的作用的，主要是三類檔案，第一mapper介面，第二xml檔案，第三全域性配置檔案（application.properties）,而今天我們就是來簡化mybatis的工作的——利用註解替代xml配置檔案。 　　先貼出mapper介面程式碼 @

sprngboot整合Mybatis（註解開發）

官方說明：MyBatis-Spring-Boot-Starter will help you use MyBatis with Spring Boot 其實就是myBatis看spring boot這麼火熱，為了迎合springboot也開發出一套解決方案來湊湊熱鬧, my

9 mybatis註解式開發

mybatis的註解，主要用於替換對映檔案。而對映檔案中無非存放著增刪改查的SQL對映標籤。所以，mybatis註解，就是要替換對映檔案中的SQL標籤。 mybatis官方不建議通過註解方式來使用mybatis 註解的基礎語法 註解後是沒有分號的 註解首字母是

Mybatis(六）逆向工程generator

逆向工程概述：　　 　　MyBatis的一個主要的特點就是需要程式設計師自己編寫sql，那麼如果表太多的話，難免會很麻煩，所以mybatis官方提供了一個逆向工程，可以針對單表自動生成mybatis執行所需要的程式碼（包括mapper.xml、mapper.java、pojo..）。一般在開發中，常用的逆向

mybatis 註解式開發

MyBatis的註解，主要是用於替換對映檔案。對映檔案中無非存放在增刪改查的sql對映標籤。所以，MyBatis註解，就是要替換對映檔案中的SQL標籤。 MyBatis官方文件中指出，若要真正想發揮MyBatis功能，還是要用對映檔案。所以官方並不建議使用MyBatis註