Spring Boot(六)集成 MyBatis 操作 MySQL 8

一、簡介

1.1 MyBatis介紹

MyBatis 是一款優(yōu)秀的持久層框架辣恋,它支持定制化 SQL奖亚、存儲過程以及高級映射。MyBatis 避免了幾乎所有的 JDBC代碼和手動設置參數以及獲取結果集艾船。

1.2 MyBatis發(fā)展史

MyBatis 原本是apache的一個開源項目iBatis, 2010年這個項目由apache software foundation 遷移到了google code,并且改名為MyBatis 高每,2013年11月遷移到Github屿岂。

1.3 MyBatis和Hibernate的區(qū)別

MyBatis 和 Hibernate 都是優(yōu)秀的持久化框架,都支持JDBC(Java DataBase Connection)和JTA(Java Transaction API)事務處理鲸匿。

MyBatis 優(yōu)點

  • 更加輕量級爷怀,如果說Hibernate是全自動的框架,MyBatis就是半自動的框架带欢;
  • 入門簡單运授,即學即用,并且延續(xù)了很好的SQL使用經驗乔煞;

Hibernate 優(yōu)點

  • 開發(fā)簡單吁朦、高效,不需要編寫SQL就可以進行基礎的數據庫操作渡贾;
  • 可移植行好逗宜,大大降低了MySQL和Oracle之間切換的成本(因為使用了HQL查詢,而不是直接寫SQL語句)剥啤;
  • 緩存機制上Hibernate也好于MyBatis锦溪;

1.4 MyBatis集成方式

Mybatis集成方式分為兩種:

  • 注解版集成
  • XML版本集成

XML版本為老式的配置集成方式,重度集成XML文件府怯,SQL語句也是全部寫在XML中的;注解版版本防楷,相對來說比較簡約牺丙,不需要XML配置,只需要使用注解和代碼來操作數據复局。

二冲簿、注解版 MyBatis 集成

開發(fā)環(huán)境

  • MySQL 8.0.12
  • Spring Boot 2.0.4
  • MyBatis Spring Boot 1.3.2(等于 MyBatis 3.4.6)
  • JDK 8
  • IDEA 2018.2

MyBatis Spring Boot 是 MyBatis 官方為了集成 Spring Boot 而推出的MyBatis版本。

2.1 添加依賴

設置pom.xml文件亿昏,添加如下配置

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.12</version>
</dependency>

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

添加 MySQL 和 MyBatis 支持峦剔。

2.2 配置數據庫連接

設置application.properties文件,添加如下配置

# MyBatis 配置
spring.datasource.url=jdbc:mysql://172.16.10.79:3306/mytestdb?serverTimezone=UTC&useSSL=false&allowPublicKeyRetrieval=true
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
mybatis.type-aliases-package=com.hello.springboot.mapper
  • spring.datasource.url 數據庫連接字符串
  • spring.datasource.username 數據庫用戶名
  • spring.datasource.password 數據庫密碼
  • spring.datasource.driver-class-name 驅動類型(注意MySQL 8.0的值是com.mysql.cj.jdbc.Driver和之前不同)
  • mybatis.type-aliases-package 配置mapper包名

Mapper文件說明

Mapper是MyBatis的核心角钩,是SQL存儲的地方吝沫,也是配置數據庫映射的地方呻澜。

2.3 設置 MapperScan 包路徑

直接在啟動文件SpringbootApplication.java的類上配置@MapperScan,這樣就可以省去惨险,單獨給每個Mapper上標識@Mapper的麻煩羹幸。

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

2.4 添加代碼

為了演示的簡潔性,我們不做太多的分層處理了辫愉,我們這里就分為:實體類栅受、Mapper接口、Controller類恭朗,使用Controller直接調用Mapper接口進行數據持久化處理屏镊。

User 類:

public class User {
    private Long id;
    private String name;
    private int age;
    private String pwd;
    //省去set、get方法
}

UserMapper 接口:

public interface UserMapper {
    @Select("select * from user")
    @Results({
            @Result(property = "name", column = "name")
    })
    List<User> getAll();

    @Select("select * from user where id=#{id}")
    User getById(Long id);

    @Insert({"insert into user(name,age,pwd) values(#{name},#{age},#{pwd})"})
    void install(User user);

    @Update({"update user set name=#{name} where id=#{id}"})
    void Update(User user);

    @Delete("delete from user where id=#{id}")
    void delete(Long id);
}

可以看出來痰腮,所有的SQL都是寫在Mapper接口里面的而芥。

Mapper里的注解說明

  • @Select 查詢注解
  • @Result 結果集標識,用來對應數據庫列名的诽嘉,如果實體類屬性和數據庫屬性名保持一致蔚出,可以忽略此參數
  • @Insert 插入注解
  • @Update 修改注解
  • @Delete 刪除注解

Controller 控制器:

@RestController
@RequestMapping("/")
public class UserController {
    @Autowired
    private UserMapper userMapper;
    @RequestMapping("/")
    public ModelAndView index() {
        User user = new User();
        user.setAge(18);
        user.setName("Adam");
        user.setPwd("123456");
        userMapper.install(user);
        ModelAndView modelAndView = new ModelAndView("/index");
        modelAndView.addObject("count", userMapper.getAll().size());
        return modelAndView;
    }
}

到此為止,已經完成了MyBatis項目的配置了虫腋,可以運行調試了骄酗。

注解版GitHub源碼下載:https://github.com/vipstone/springboot-example/tree/master/springboot-mybatis

三、XML 版 MyBatis 集成

3.1 添加依賴

設置pom.xml文件悦冀,添加如下配置

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.12</version>
</dependency>

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

添加 MySQL 和 MyBatis 支持趋翻。

3.2 配置數據庫連接

設置application.properties文件,添加如下配置

# MyBatis 配置
spring.datasource.url=jdbc:mysql://172.16.10.79:3306/mytestdb?serverTimezone=UTC&useSSL=false&allowPublicKeyRetrieval=true
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
mybatis.type-aliases-package=com.hello.springboot.entity
mybatis.config-locations=classpath:mybatis/mybatis-config.xml
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml
  • spring.datasource.url 數據庫連接字符串
  • spring.datasource.username 數據庫用戶名
  • spring.datasource.password 數據庫密碼
  • spring.datasource.driver-class-name 驅動類型(注意MySQL 8.0的值是com.mysql.cj.jdbc.Driver和之前不同)
  • mybatis.type-aliases-package 實體類包路徑
  • mybatis.config-locations 配置MyBatis基礎屬性
  • mybatis.mapper-locations 配置Mapper XML文件

3.3 設置 MapperScan 包路徑

直接在啟動文件SpringbootApplication.java的類上配置@MapperScan盒蟆,這樣就可以省去踏烙,單獨給每個Mapper上標識@Mapper的麻煩。

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

3.4 配置XML文件

本示例設置兩個xml文件历等,在resource/mybatis下的mybatis-config.xml(配置MyBatis基礎屬性)和在resource/mybatis/mapper下的UserMapper.xml(用戶和數據交互的SQL語句)讨惩。

mybatis-config.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>
    <typeAliases>
        <typeAlias alias="Integer" type="java.lang.Integer"/>
        <typeAlias alias="Long" type="java.lang.Long"/>
        <typeAlias alias="HashMap" type="java.util.HashMap"/>
        <typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap"/>
        <typeAlias alias="ArrayList" type="java.util.ArrayList"/>
        <typeAlias alias="LinkedList" type="java.util.LinkedList"/>
    </typeAliases>
</configuration>

UserMapper.xml

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

<!--namespace是命名空間,是mapper接口的全路徑-->
<mapper namespace="com.hello.springboot.mapper.UserMapper">

    <!--resultMap – 是最復雜也是最強大的元素寒屯,用來描述如何從數據庫結果集中來加載對象-->
    <resultMap id="userResultMap" type="com.hello.springboot.entity.User">
        <id property="name" column="username"></id>
    </resultMap>

    <!--sql – 可被其他語句引用的可重用語句塊-->
    <sql id="colums">
        id,username,age,pwd
    </sql>

    <select id="findAll" resultMap="userResultMap">
        select
        <include refid="colums" />
        from  user
    </select>

    <select id="findById" resultMap="userResultMap">
        select
        <include refid="colums" />
        from  user
        where  id=#{id}
    </select>

    <insert id="insert" parameterType="com.hello.springboot.entity.User" >
       INSERT INTO
            user
            (username,age,pwd)
        VALUES
            (#{name}, #{age}, #{pwd})
    </insert>

    <update id="update" parameterType="com.hello.springboot.entity.User" >
        UPDATE
        users
        SET
        <if test="username != null">username = #{username},</if>
        <if test="pwd != null">pwd = #{pwd},</if>
        username = #{username}
        WHERE
        id = #{id}
    </update>

    <delete id="delete" parameterType="java.lang.Long" >
       DELETE FROM
             user
       WHERE
             id =#{id}
    </delete>

</mapper>

SQL 映射文件有很少的幾個頂級元素(按照它們應該被定義的順序):

  • cache – 給定命名空間的緩存配置荐捻。
  • cache-ref – 其他命名空間緩存配置的引用。
  • resultMap – 是最復雜也是最強大的元素寡夹,用來描述如何從數據庫結果集中來加載對象处面。
  • parameterMap – 已廢棄!老式風格的參數映射菩掏。內聯(lián)參數是首選,這個元素可能在將來被移除魂角,這里不會記錄。
  • sql – 可被其他語句引用的可重用語句塊智绸。
  • insert – 映射插入語句
  • update – 映射更新語句
  • delete – 映射刪除語句
  • select – 映射查詢語句

注意: MyBatis中 config 和 mapper 的 XML 頭文件是不一樣的野揪。

config 頭文件

<?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">

mapper 頭文件

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

Mapper XML 更多配置:http://www.mybatis.org/mybatis-3/zh/sqlmap-xml.html

3.5 添加代碼

為了演示的便捷性访忿,我們添加3個類用于功能的展示,分別是實體類User.java囱挑、mapper接口UserMapper.java和控制器類UserController.java醉顽,使用控制器類直接調用UserMapper的方法,進行數據存儲和查詢平挑。

User.java

package com.hello.springboot.entity;
public class User {
    private Long id;
    private String name;
    private int age;
    private String pwd;
    //省略set/get方法
}

UserMapper.java

package com.hello.springboot.mapper;
import com.hello.springboot.entity.User;
import java.util.List;
public interface UserMapper {
    List<User> findAll();
    User findById(Long id);
    void insert(User user);
    void update(User user);
    void delete(Long id);
}

注意: Mapper里的方法名必須和Mapper XML里的一致游添,不然會找不到執(zhí)行的SQL。

UserController.java

@RestController
@RequestMapping("/")
public class UserController {
    @Resource
    private UserMapper userMapper;

    @RequestMapping("/")
    public ModelAndView index() {
        User user = new User();
        user.setAge(18);
        user.setName("Adam");
        user.setPwd("123456");
        userMapper.insert(user);
        ModelAndView modelAndView = new ModelAndView("/index");
        modelAndView.addObject("count", userMapper.findAll().size());
        return modelAndView;
    }

}

到此為止通熄,已經完成了MyBatis項目的配置了唆涝,可以運行調試了。

XML版GitHub源碼下載:https://github.com/vipstone/springboot-example/tree/master/springboot-mybatis-xml

四唇辨、總結

到目前為止我們已經掌握了MyBatis的兩種集成方式廊酣,注解集成和XML集成,注解版更符合程序員的代碼書寫習慣赏枚,適用于簡單快速查詢亡驰;XML版可以靈活的動態(tài)調整SQL,更適合大型項目開發(fā)饿幅,具體的選擇還要看開發(fā)場景以及個人喜好了凡辱。

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市栗恩,隨后出現的幾起案子透乾,更是在濱河造成了極大的恐慌,老刑警劉巖磕秤,帶你破解...
    沈念sama閱讀 218,941評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件乳乌,死亡現場離奇詭異,居然都是意外死亡市咆,警方通過查閱死者的電腦和手機汉操,發(fā)現死者居然都...
    沈念sama閱讀 93,397評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來蒙兰,“玉大人客情,你說我怎么就攤上這事●海” “怎么了?”我有些...
    開封第一講書人閱讀 165,345評論 0 356
  • 文/不壞的土叔 我叫張陵梭伐,是天一觀的道長痹雅。 經常有香客問我,道長糊识,這世上最難降的妖魔是什么绩社? 我笑而不...
    開封第一講書人閱讀 58,851評論 1 295
  • 正文 為了忘掉前任摔蓝,我火速辦了婚禮,結果婚禮上愉耙,老公的妹妹穿的比我還像新娘贮尉。我一直安慰自己,他們只是感情好朴沿,可當我...
    茶點故事閱讀 67,868評論 6 392
  • 文/花漫 我一把揭開白布猜谚。 她就那樣靜靜地躺著,像睡著了一般赌渣。 火紅的嫁衣襯著肌膚如雪魏铅。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,688評論 1 305
  • 那天坚芜,我揣著相機與錄音览芳,去河邊找鬼。 笑死鸿竖,一個胖子當著我的面吹牛沧竟,可吹牛的內容都是我干的。 我是一名探鬼主播缚忧,決...
    沈念sama閱讀 40,414評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼悟泵,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了搔谴?” 一聲冷哼從身側響起魁袜,我...
    開封第一講書人閱讀 39,319評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎敦第,沒想到半個月后峰弹,有當地人在樹林里發(fā)現了一具尸體,經...
    沈念sama閱讀 45,775評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡芜果,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年鞠呈,在試婚紗的時候發(fā)現自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片右钾。...
    茶點故事閱讀 40,096評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡蚁吝,死狀恐怖,靈堂內的尸體忽然破棺而出舀射,到底是詐尸還是另有隱情窘茁,我是刑警寧澤,帶...
    沈念sama閱讀 35,789評論 5 346
  • 正文 年R本政府宣布脆烟,位于F島的核電站山林,受9級特大地震影響,放射性物質發(fā)生泄漏邢羔。R本人自食惡果不足惜驼抹,卻給世界環(huán)境...
    茶點故事閱讀 41,437評論 3 331
  • 文/蒙蒙 一桑孩、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧框冀,春花似錦流椒、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,993評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至诡右,卻和暖如春安岂,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背帆吻。 一陣腳步聲響...
    開封第一講書人閱讀 33,107評論 1 271
  • 我被黑心中介騙來泰國打工域那, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人猜煮。 一個月前我還...
    沈念sama閱讀 48,308評論 3 372
  • 正文 我出身青樓次员,卻偏偏與公主長得像,于是被迫代替她去往敵國和親王带。 傳聞我的和親對象是個殘疾皇子淑蔚,可洞房花燭夜當晚...
    茶點故事閱讀 45,037評論 2 355

推薦閱讀更多精彩內容