MyBatis 是一款優秀的持久層框架,它支持定製化 SQL、存儲過程以及高級映射。MyBatis 避免了幾乎全部的 JDBC代碼和手動設置參數以及獲取結果集。html
MyBatis 本來是apache的一個開源項目iBatis, 2010年這個項目由apache software foundation 遷移到了google code,而且更名爲MyBatis ,2013年11月遷移到Github。java
<!--more-->mysql
MyBatis 和 Hibernate 都是優秀的持久化框架,都支持JDBC(Java DataBase Connection)和JTA(Java Transaction API)事務處理。git
MyBatis 優勢程序員
Hibernate 優勢github
Mybatis集成方式分爲兩種:spring
XML版本爲老式的配置集成方式,重度集成XML文件,SQL語句也是所有寫在XML中的;註解版版本,相對來講比較簡約,不須要XML配置,只須要使用註解和代碼來操做數據。sql
開發環境數據庫
MyBatis Spring Boot 是 MyBatis 官方爲了集成 Spring Boot 而推出的MyBatis版本。apache
設置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 支持。
設置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
Mapper文件說明
Mapper是MyBatis的核心,是SQL存儲的地方,也是配置數據庫映射的地方。
直接在啓動文件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); } }
爲了演示的簡潔性,咱們不作太多的分層處理了,咱們這裏就分爲:實體類、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裏的註解說明
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
設置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 支持。
設置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
直接在啓動文件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); } }
本示例設置兩個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
– 已廢棄!老式風格的參數映射。內聯參數是首選,這個元素可能在未來被移除,這裏不會記錄。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個類用於功能的展現,分別是實體類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裏的一致,否則會找不到執行的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版能夠靈活的動態調整SQL,更適合大型項目開發,具體的選擇還要看開發場景以及我的喜愛了。