springboot使用Mybatis(xml和注解)過程全解析

剛畢業(yè)的第一份工作是 java 開發(fā)，項(xiàng)目中需要用到 mybatis，特此記錄學(xué)習(xí)過程，這只是一個(gè)簡(jiǎn)單 demo，mybatis 用法很多不可能全部寫出來，有更復(fù)雜的需求建議查看 mybatis 的官方中文文檔，點(diǎn)擊跳轉(zhuǎn)。下面時(shí)項(xiàng)目環(huán)境/版本。

創(chuàng)新互聯(lián)成立以來不斷整合自身及行業(yè)資源、不斷突破觀念以使企業(yè)策略得到完善和成熟，建立了一套“以技術(shù)為基點(diǎn)，以客戶需求中心、市場(chǎng)為導(dǎo)向”的快速反應(yīng)體系。對(duì)公司的主營(yíng)項(xiàng)目，如中高端企業(yè)網(wǎng)站企劃 / 設(shè)計(jì)、行業(yè) / 企業(yè)門戶設(shè)計(jì)推廣、行業(yè)門戶平臺(tái)運(yùn)營(yíng)、app軟件開發(fā)、移動(dòng)網(wǎng)站建設(shè)、微信網(wǎng)站制作、軟件開發(fā)、成都服務(wù)器托管等實(shí)行標(biāo)準(zhǔn)化操作，讓客戶可以直觀的預(yù)知到從創(chuàng)新互聯(lián)可以獲得的服務(wù)效果。

•開發(fā)工具：IDEA
•jdk 版本：1.8
•springboot 版本：2.03

其他依賴版本見下面 pom.xml:

 <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <groupId>com.example</groupId>
 <artifactId>mybatis-test</artifactId>
 <version>0.0.1-SNAPSHOT</version>
 <packaging>jar</packaging>
 <name>mybatis-test</name>
 <description>Demo project for Spring Boot</description>
 <parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>2.0.3.RELEASE</version>
  <relativePath/> <!-- lookup parent from repository -->
 </parent>
 <properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  <java.version>1.8</java.version>
 </properties>
 <dependencies>
  <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <dependency>
   <groupId>MySQL</groupId>
   <artifactId>mysql-connector-java</artifactId>
   <scope>runtime</scope>
  </dependency>
  <!--mybatis依賴 -->
  <dependency>
   <groupId>org.mybatis.spring.boot</groupId>
   <artifactId>mybatis-spring-boot-starter</artifactId>
   <version>1.3.2</version>
  </dependency>
  <!--alibaba連接池依賴-->
  <dependency>
   <groupId>com.alibaba</groupId>
   <artifactId>druid-spring-boot-starter</artifactId>
   <version>1.1.9</version>
  </dependency>
  <!--分頁(yè)依賴-->
  <dependency>
   <groupId>com.github.pagehelper</groupId>
   <artifactId>pagehelper-spring-boot-starter</artifactId>
   <version>1.2.5</version>
  </dependency>
  <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-test</artifactId>
   <scope>test</scope>
  </dependency>
 </dependencies>
 <build>
  <plugins>
   <plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
   </plugin>
  </plugins>
 </build>
</project>

1.創(chuàng)建項(xiàng)目

使用 idea 中的 spring initializr 生成 maven 項(xiàng)目，項(xiàng)目命令為 mybatis-test，選擇 web，mysql，mybatis 依賴，即可成功。（詳細(xì)過程不贅述，如有需要學(xué)習(xí) springboot 創(chuàng)建過程，可參考這篇文章。

然后依照上面的 pom 文件，補(bǔ)齊缺少的依賴。接著創(chuàng)建包 entity，service 和 mybatis 映射文件夾 mapper，創(chuàng)建。為了方便配置將 application.properties 改成 application.yml。由于我們時(shí) REST 接口，故不需要 static 和 templates 目錄。修改完畢后的項(xiàng)目結(jié)構(gòu)如下：

springboot使用Mybatis(xml和注解)過程全解析

項(xiàng)目結(jié)構(gòu)

修改啟動(dòng)類，增加@MapperScan("com.example.mybatistest.dao"),以自動(dòng)掃描 dao 目錄，避免每個(gè) dao 都手動(dòng)加@Mapper注解。代碼如下：

@SpringBootApplication
@MapperScan("com.example.mybatistest.dao")
public class MybatisTestApplication {
 public static void main(String[] args) {
  SpringApplication.run(MybatisTestApplication.class, args);
 }
}

修改 application.yml,配置項(xiàng)目，代碼如下：

mybatis:
 #對(duì)應(yīng)實(shí)體類路徑
 type-aliases-package: com.example.mybatistest.entity
 #對(duì)應(yīng)mapper映射文件路徑
 mapper-locations: classpath:mapper/*.xml
#pagehelper物理分頁(yè)配置
pagehelper:
 helper-dialect: mysql
 reasonable: true
 support-methods-arguments: true
 params: count=countSql
 returnPageInfo: check
server:
 port: 8081
spring:
 datasource:
 name: mysqlTest
 type: com.alibaba.druid.pool.DruidDataSource
 #druid連接池相關(guān)配置
 druid:
  #監(jiān)控?cái)r截統(tǒng)計(jì)的filters
  filters: stat
  driver-class-name: com.mysql.jdbc.Driver
  url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=true
  username: root
  password: 123456
  #配置初始化大小，最小，最大
  initial-size: 1
  min-idle: 1
  max-active: 20
  #獲取連接等待超時(shí)時(shí)間
  max-wait: 6000
  #間隔多久檢測(cè)一次需要關(guān)閉的空閑連接
  time-between-eviction-runs-millis: 60000
  #一個(gè)連接在池中的最小生存時(shí)間
  min-evictable-idle-time-millis: 300000
  #打開PSCache，并指定每個(gè)連接上PSCache的大小。oracle設(shè)置為true，mysql設(shè)置為false。分庫(kù)分表設(shè)置較多推薦設(shè)置
  pool-prepared-statements: false
  max-pool-prepared-statement-per-connection-size: 20
 http:
 encoding:
  charset: utf-8
  enabled: true

2.編寫代碼

首先創(chuàng)建數(shù)據(jù)表，sql 語(yǔ)句如下：

CREATE TABLE `user` (
 `id` int(11) NOT NULL AUTO_INCREMENT,
 `name` varchar(255) NOT NULL,
 `age` tinyint(4) NOT NULL DEFAULT '0',
 `password` varchar(255) NOT NULL DEFAULT '123456',
 PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=utf8;

然后在 entity 包中創(chuàng)建實(shí)體類 User.java

public class User {
 private int id;
 private String name;
 private int age;
 private String password;
 public User(int id, String name, int age, String password) {
  this.id = id;
  this.name = name;
  this.age = age;
  this.password = password;
 }
 public User(){}
 //getter setter自行添加
}

在 dao 包下創(chuàng)建 UserDao.java

public interface UserDao {
 //插入用戶
 int insert(User user);
 //根據(jù)id查詢
 User selectById(String id);
 //查詢所有
 List<User> selectAll();
}

在 mapper 文件夾下創(chuàng)建 UserMapper.xml,具體的 xml 編寫方法查看文首的官方文檔。

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.example.mybatistest.dao.UserDao">
 <sql id="BASE_TABLE">
  user
 </sql>
 <sql id="BASE_COLUMN">
  id,name,age,password
 </sql>
 <insert id="insert" parameterType="com.example.mybatistest.entity.User" useGeneratedKeys="true" keyProperty="id">
  INSERT INTO <include refid="BASE_TABLE"/>
  <trim prefix="(" suffix=")" suffixOverrides=",">
   name,password,
   <if test="age!=null">
    age
   </if>
  </trim>
  <trim prefix=" VALUE(" suffix=")" suffixOverrides=",">
   #{name,jdbcType=VARCHAR},#{password},
   <if test="age!=null">
    #{age}
   </if>
  </trim>
 </insert>
 <select id="selectById" resultType="com.example.mybatistest.entity.User">
  select
   <include refid="BASE_COLUMN"/>
  from
   <include refid="BASE_TABLE"/>
  where id=#{id}
 </select>
 <select id="selectAll" resultType="com.example.mybatistest.entity.User">
  select
   <include refid="BASE_COLUMN"/>
  from
   <include refid="BASE_TABLE"/>
 </select>
</mapper>

至此使用 mybatis 的代碼編寫完了，之后要用時(shí)調(diào)用 dao 接口中的方法即可。

3.測(cè)試

我們通過編寫 service，controller 然后使用 postman 進(jìn)行測(cè)試。

首先編寫 UserService.java,代碼如下：

@Component
public class UserService {
 @Autowired
 private UserDao userDao;
 public User getByUserId(String id){
  return userDao.selectById(id);
 }
 //獲取全部用戶
 public List<User> getAll(){
  return userDao.selectAll();
 }
 //測(cè)試分頁(yè)
 public PageInfo<User> getAll(int pageNum,int pageSize){
  PageHelper.startPage(pageNum,pageSize);
  List<User> users = userDao.selectAll();
  System.out.println(users.size());
  PageInfo<User> result = new PageInfo<>(users);
  return result;
 }
 public int insert(User user){
  return userDao.insert(user);
 }
}

編寫 UserController.java

@RestController
public class UserController {
 @Autowired
 private UserService userService;
 @GetMapping("/user/{userId}")
 public User getUser(@PathVariable String userId){
  return userService.getByUserId(userId);
 }
 @GetMapping("/user")
 public List<User> getAll(){
  return userService.getAll();
 }
 @GetMapping("/user/page/{pageNum}")
 public Object getPage(@PathVariable int pageNum,
       @RequestParam(name = "pageSize",required = false,defaultValue = "10") int pageSize){
  return userService.getAll(pageNum,pageSize);
 }
 @PostMapping("/user")
 public Object addOne(User user){
  userService.insert(user);
  return user;
 }
}

啟動(dòng)項(xiàng)目，通過 postman 進(jìn)行請(qǐng)求測(cè)試，測(cè)試結(jié)果如下：

•插入數(shù)據(jù)：

springboot使用Mybatis(xml和注解)過程全解析

•查詢數(shù)據(jù)

springboot使用Mybatis(xml和注解)過程全解析

•分頁(yè)查詢

springboot使用Mybatis(xml和注解)過程全解析

4.注解編寫 sql

上面使用的是 xml 方式編寫 sql 代碼，其實(shí) mybatis 也支持在注解中編寫 sql，這樣可以避免編寫復(fù)雜的 xml 查詢文件，但同時(shí)也將 sql 語(yǔ)句耦合到了代碼中，也不易實(shí)現(xiàn)復(fù)雜查詢，因此多用于簡(jiǎn)單 sql 語(yǔ)句的編寫。

要使用注解首先將 applicaton.yml 配置文件中的mapper-locations: classpath:mapper/*.xml注釋掉。然后在 UserDao.java 中加入 sql 注解，代碼如下：

public interface UserDao {
 //插入用戶
 @Insert("insert into user(name,age,password) value(#{name},#{age},#{password})")
 @Options(useGeneratedKeys=true,keyColumn="id",keyProperty="id")
 int insert(User user);
 //根據(jù)id查詢
 @Select("select * from user where id=#{id}")
 User selectById(String id);
 //查詢所有
 @Select("select * from user")
 List<User> selectAll();
}

然后重新啟動(dòng)項(xiàng)目測(cè)試，測(cè)試結(jié)果跟上面完全一樣。

本文原創(chuàng)發(fā)布于：https://www.tapme.top/blog/detail/2018-09-01-10-38

源碼地址：https://github.com/FleyX/demo-project/tree/master/mybatis-test.

本文題目：springboot使用Mybatis(xml和注解)過程全解析
文章出自：http://muchs.cn/article18/piccdp.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供云服務(wù)器、品牌網(wǎng)站制作、全網(wǎng)營(yíng)銷推廣、網(wǎng)站內(nèi)鏈、響應(yīng)式網(wǎng)站、網(wǎng)頁(yè)設(shè)計(jì)公司

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來源：創(chuàng)新互聯(lián)

猜你還喜歡下面的內(nèi)容