经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » Java相关 » Spring Boot » 查看文章
springboot使用Mybatis(xml和注解)全解析
来源：cnblogs　　作者：烦嚣的人　　时间：2019/5/27 10:11:56　　对本文有异议

刚毕业的第一份工作是 java 开发，项目中需要用到 mybatis，特此记录学习过程，这只是一个简单 demo，mybatis 用法很多不可能全部写出来，有更复杂的需求建议查看 mybatis 的官方中文文档，点击跳转。下面时项目环境/版本。

  • 开发工具：IDEA
  • jdk 版本：1.8
  • springboot 版本：2.03

其他依赖版本见下面 pom.xml:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  6.     <groupId>com.example</groupId>
  7.     <artifactId>mybatis-test</artifactId>
  8.     <version>0.0.1-SNAPSHOT</version>
  9.     <packaging>jar</packaging>
  11.     <name>mybatis-test</name>
  12.     <description>Demo project for Spring Boot</description>
  14.     <parent>
  15.         <groupId>org.springframework.boot</groupId>
  16.         <artifactId>spring-boot-starter-parent</artifactId>
  17.         <version>2.0.3.RELEASE</version>
  18.         <relativePath/> <!-- lookup parent from repository -->
  19.     </parent>
  21.     <properties>
  22.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  23.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  24.         <java.version>1.8</java.version>
  25.     </properties>
  27.     <dependencies>
  28.         <dependency>
  29.             <groupId>org.springframework.boot</groupId>
  30.             <artifactId>spring-boot-starter-web</artifactId>
  31.         </dependency>
  32.         <dependency>
  33.             <groupId>mysql</groupId>
  34.             <artifactId>mysql-connector-java</artifactId>
  35.             <scope>runtime</scope>
  36.         </dependency>
  37.         <!--mybatis依赖 -->
  38.         <dependency>
  39.             <groupId>org.mybatis.spring.boot</groupId>
  40.             <artifactId>mybatis-spring-boot-starter</artifactId>
  41.             <version>1.3.2</version>
  42.         </dependency>
  43.         <!--alibaba连接池依赖-->
  44.         <dependency>
  45.             <groupId>com.alibaba</groupId>
  46.             <artifactId>druid-spring-boot-starter</artifactId>
  47.             <version>1.1.9</version>
  48.         </dependency>
  49.         <!--分页依赖-->
  50.         <dependency>
  51.             <groupId>com.github.pagehelper</groupId>
  52.             <artifactId>pagehelper-spring-boot-starter</artifactId>
  53.             <version>1.2.5</version>
  54.         </dependency>
  55.         <dependency>
  56.             <groupId>org.springframework.boot</groupId>
  57.             <artifactId>spring-boot-starter-test</artifactId>
  58.             <scope>test</scope>
  59.         </dependency>
  60.     </dependencies>
  62.     <build>
  63.         <plugins>
  64.             <plugin>
  65.                 <groupId>org.springframework.boot</groupId>
  66.                 <artifactId>spring-boot-maven-plugin</artifactId>
  67.             </plugin>
  68.         </plugins>
  69.     </build>
  70. </project>

1.创建项目

使用 idea 中的 spring initializr 生成 maven 项目，项目命令为 mybatis-test，选择 web，mysql，mybatis 依赖，即可成功。（详细过程不赘述，如有需要学习 springboot 创建过程，可参考这篇文章。

然后依照上面的 pom 文件，补齐缺少的依赖。接着创建包 entity，service 和 mybatis 映射文件夹 mapper，创建。为了方便配置将 application.properties 改成 application.yml。由于我们时 REST 接口，故不需要 static 和 templates 目录。修改完毕后的项目结构如下：

项目结构

修改启动类，增加@MapperScan("com.example.mybatistest.dao"),以自动扫描 dao 目录，避免每个 dao 都手动加@Mapper注解。代码如下：

  1. @SpringBootApplication
  2. @MapperScan("com.example.mybatistest.dao")
  3. public class MybatisTestApplication {
  4.     public static void main(String[] args) {
  5.         SpringApplication.run(MybatisTestApplication.class, args);
  6.     }
  7. }

修改 application.yml,配置项目，代码如下：

  1. mybatis:
  2.   #对应实体类路径
  3.   type-aliases-package: com.example.mybatistest.entity
  4.   #对应mapper映射文件路径
  5.   mapper-locations: classpath:mapper/*.xml
  7. #pagehelper物理分页配置
  8. pagehelper:
  9.   helper-dialect: mysql
  10.   reasonable: true
  11.   support-methods-arguments: true
  12.   params: count=countSql
  13.   returnPageInfo: check
  15. server:
  16.   port: 8081
  18. spring:
  19.   datasource:
  20.     name: mysqlTest
  21.     type: com.alibaba.druid.pool.DruidDataSource
  22.     #druid连接池相关配置
  23.     druid:
  24.       #监控拦截统计的filters
  25.       filters: stat
  26.       driver-class-name: com.mysql.jdbc.Driver
  27.       url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=true
  28.       username: root
  29.       password: 123456
  30.       #配置初始化大小，最小，最大
  31.       initial-size: 1
  32.       min-idle: 1
  33.       max-active: 20
  34.       #获取连接等待超时时间
  35.       max-wait: 6000
  36.       #间隔多久检测一次需要关闭的空闲连接
  37.       time-between-eviction-runs-millis: 60000
  38.       #一个连接在池中的最小生存时间
  39.       min-evictable-idle-time-millis: 300000
  40.       #打开PSCache，并指定每个连接上PSCache的大小。oracle设置为true，mysql设置为false。分库分表设置较多推荐设置
  41.       pool-prepared-statements: false
  42.       max-pool-prepared-statement-per-connection-size: 20
  43.   http:
  44.     encoding:
  45.       charset: utf-8
  46.       enabled: true

2.编写代码

首先创建数据表，sql 语句如下：

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

然后在 entity 包中创建实体类 User.java

  1. public class User {
  2.     private int id;
  3.     private String name;
  4.     private int age;
  5.     private String password;
  7.     public User(int id, String name, int age, String password) {
  8.         this.id = id;
  9.         this.name = name;
  10.         this.age = age;
  11.         this.password = password;
  12.     }
  13.     public User(){}
  14.     //getter setter自行添加
  15. }

在 dao 包下创建 UserDao.java

  1. public interface UserDao {
  2.     //插入用户
  3.     int insert(User user);
  4.     //根据id查询
  5.     User selectById(String id);
  6.     //查询所有
  7.     List<User> selectAll();
  8. }

在 mapper 文件夹下创建 UserMapper.xml,具体的 xml 编写方法查看文首的官方文档。

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
  3. <mapper namespace="com.example.mybatistest.dao.UserDao">
  4.     <sql id="BASE_TABLE">
  5.         user
  6.     </sql>
  7.     <sql id="BASE_COLUMN">
  8.         id,name,age,password
  9.     </sql>
  11.     <insert id="insert" parameterType="com.example.mybatistest.entity.User" useGeneratedKeys="true" keyProperty="id">
  12.         INSERT INTO <include refid="BASE_TABLE"/>
  13.         <trim prefix="(" suffix=")" suffixOverrides=",">
  14.             name,password,
  15.             <if test="age!=null">
  16.                 age
  17.             </if>
  18.         </trim>
  19.         <trim prefix=" VALUE(" suffix=")" suffixOverrides=",">
  20.             #{name,jdbcType=VARCHAR},#{password},
  21.             <if test="age!=null">
  22.                 #{age}
  23.             </if>
  24.         </trim>
  25.     </insert>
  27.     <select id="selectById" resultType="com.example.mybatistest.entity.User">
  28.         select
  29.           <include refid="BASE_COLUMN"/>
  30.         from
  31.           <include refid="BASE_TABLE"/>
  32.         where id=#{id}
  33.     </select>
  35.     <select id="selectAll" resultType="com.example.mybatistest.entity.User">
  36.         select
  37.           <include refid="BASE_COLUMN"/>
  38.         from
  39.           <include refid="BASE_TABLE"/>
  40.     </select>
  41. </mapper>

至此使用 mybatis 的代码编写完了，之后要用时调用 dao 接口中的方法即可。

3.测试

我们通过编写 service，controller 然后使用 postman 进行测试。

首先编写 UserService.java,代码如下：

  1. @Component
  2. public class UserService {
  4.     @Autowired
  5.     private UserDao userDao;
  7.     public User getByUserId(String id){
  8.         return userDao.selectById(id);
  9.     }
  10.     //获取全部用户
  11.     public List<User> getAll(){
  12.         return userDao.selectAll();
  13.     }
  14.     //测试分页
  15.     public PageInfo<User> getAll(int pageNum,int pageSize){
  16.         PageHelper.startPage(pageNum,pageSize);
  17.         List<User> users = userDao.selectAll();
  18.         System.out.println(users.size());
  19.         PageInfo<User> result = new PageInfo<>(users);
  20.         return result;
  21.     }
  23.     public int insert(User user){
  24.         return userDao.insert(user);
  25.     }
  27. }

编写 UserController.java

  1. @RestController
  2. public class UserController {
  4.     @Autowired
  5.     private UserService userService;
  7.     @GetMapping("/user/{userId}")
  8.     public User getUser(@PathVariable String userId){
  9.         return userService.getByUserId(userId);
  10.     }
  12.     @GetMapping("/user")
  13.     public List<User> getAll(){
  14.         return userService.getAll();
  15.     }
  17.     @GetMapping("/user/page/{pageNum}")
  18.     public Object getPage(@PathVariable int pageNum,
  19.                           @RequestParam(name = "pageSize",required = false,defaultValue = "10") int pageSize){
  20.         return userService.getAll(pageNum,pageSize);
  21.     }
  23.     @PostMapping("/user")
  24.     public Object addOne(User user){
  25.         userService.insert(user);
  26.         return user;
  27.     }
  28. }

启动项目，通过 postman 进行请求测试，测试结果如下：

  • 插入数据：

插入

  • 查询数据

查询

  • 分页查询

分页查询

4.注解编写 sql

上面使用的是 xml 方式编写 sql 代码，其实 mybatis 也支持在注解中编写 sql，这样可以避免编写复杂的 xml 查询文件，但同时也将 sql 语句耦合到了代码中，也不易实现复杂查询，因此多用于简单 sql 语句的编写。

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

  1. public interface UserDao {
  2.     //插入用户
  3.     @Insert("insert into user(name,age,password) value(#{name},#{age},#{password})")
  4.     @Options(useGeneratedKeys=true,keyColumn="id",keyProperty="id")
  5.     int insert(User user);
  6.     //根据id查询
  7.     @Select("select * from user where id=#{id}")
  8.     User selectById(String id);
  9.     //查询所有
  10.     @Select("select * from user")
  11.     List<User> selectAll();
  12. }

然后重新启动项目测试，测试结果跟上面完全一样。

本文原创发布于：https://www.tapme.top/blog/detail/2018-09-01-10-38

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

原文链接：http://www.cnblogs.com/wuyoucao/p/10929044.html

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Spring Boot热门文章

  • 史上最详 Thymeleaf 使用教程
  • Spring Boot如何通过java -jar启动
  • Spring Boot 2.x（六）：优雅的统一返回值
  • Springboot使用Logback实现日志配置与异常记录
  • 使用SpringBoot+EasyExcel+Vue实现excel表格的导入和导出详解
  • spring boot上传文件超出大小异常无法捕获问题
  • paging组件的用法和意义
  • springboot2.0集成rabbitmq的示例代码
  • Spring MVC学习step1——框架熟悉
  • spring boot ${}占位符不起作用的解决方案

    • Spring Boot推荐文章

  • 3分钟带你搞定Spring Boot中Schedule
  • 不单独部署注册中心，又要具备注册中心的功能，我能上天！
  • 从零开始学Spring Boot系列-集成Spring Security实现用户认证与授权
  • 不单独部署注册中心，又要具备注册中心的功能，咋不让我上天？
  • EasyExcel 无法读取图片？用poi写了一个工具类
  • 【进阶篇】使用 Stream 流对比两个集合的常用操作分享
  • 关于DDD和COLA的一些总结和思考
  • SnakeYaml反序列化分析
  • RestTemplate进行https请求时适配信任证书
  • Kryo反序列化链分析

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号