​  刚毕业的第一份工作是 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>
  5. <groupId>com.example</groupId>
  6. <artifactId>mybatis-test</artifactId>
  7. <version>0.0.1-SNAPSHOT</version>
  8. <packaging>jar</packaging>
  9. <name>mybatis-test</name>
  10. <description>Demo project for Spring Boot</description>
  11. <parent>
  12. <groupId>org.springframework.boot</groupId>
  13. <artifactId>spring-boot-starter-parent</artifactId>
  14. <version>2.0.3.RELEASE</version>
  15. <relativePath/> <!-- lookup parent from repository -->
  16. </parent>
  17. <properties>
  18. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  19. <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  20. <java.version>1.8</java.version>
  21. </properties>
  22. <dependencies>
  23. <dependency>
  24. <groupId>org.springframework.boot</groupId>
  25. <artifactId>spring-boot-starter-web</artifactId>
  26. </dependency>
  27. <dependency>
  28. <groupId>mysql</groupId>
  29. <artifactId>mysql-connector-java</artifactId>
  30. <scope>runtime</scope>
  31. </dependency>
  32. <!--mybatis依赖 -->
  33. <dependency>
  34. <groupId>org.mybatis.spring.boot</groupId>
  35. <artifactId>mybatis-spring-boot-starter</artifactId>
  36. <version>1.3.2</version>
  37. </dependency>
  38. <!--alibaba连接池依赖-->
  39. <dependency>
  40. <groupId>com.alibaba</groupId>
  41. <artifactId>druid-spring-boot-starter</artifactId>
  42. <version>1.1.9</version>
  43. </dependency>
  44. <!--分页依赖-->
  45. <dependency>
  46. <groupId>com.github.pagehelper</groupId>
  47. <artifactId>pagehelper-spring-boot-starter</artifactId>
  48. <version>1.2.5</version>
  49. </dependency>
  50. <dependency>
  51. <groupId>org.springframework.boot</groupId>
  52. <artifactId>spring-boot-starter-test</artifactId>
  53. <scope>test</scope>
  54. </dependency>
  55. </dependencies>
  56. <build>
  57. <plugins>
  58. <plugin>
  59. <groupId>org.springframework.boot</groupId>
  60. <artifactId>spring-boot-maven-plugin</artifactId>
  61. </plugin>
  62. </plugins>
  63. </build>
  64. </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
  6. #pagehelper物理分页配置
  7. pagehelper:
  8. helper-dialect: mysql
  9. reasonable: true
  10. support-methods-arguments: true
  11. params: count=countSql
  12. returnPageInfo: check
  13. server:
  14. port: 8081
  15. spring:
  16. datasource:
  17. name: mysqlTest
  18. type: com.alibaba.druid.pool.DruidDataSource
  19. #druid连接池相关配置
  20. druid:
  21. #监控拦截统计的filters
  22. filters: stat
  23. driver-class-name: com.mysql.jdbc.Driver
  24. url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=true
  25. username: root
  26. password: 123456
  27. #配置初始化大小,最小,最大
  28. initial-size: 1
  29. min-idle: 1
  30. max-active: 20
  31. #获取连接等待超时时间
  32. max-wait: 6000
  33. #间隔多久检测一次需要关闭的空闲连接
  34. time-between-eviction-runs-millis: 60000
  35. #一个连接在池中的最小生存时间
  36. min-evictable-idle-time-millis: 300000
  37. #打开PSCache,并指定每个连接上PSCache的大小。oracle设置为true,mysql设置为false。分库分表设置较多推荐设置
  38. pool-prepared-statements: false
  39. max-pool-prepared-statement-per-connection-size: 20
  40. http:
  41. encoding:
  42. charset: utf-8
  43. 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;
  6. public User(int id, String name, int age, String password) {
  7. this.id = id;
  8. this.name = name;
  9. this.age = age;
  10. this.password = password;
  11. }
  12. public User(){}
  13. //getter setter自行添加
  14. }

​ 在 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>
  10. <insert id="insert" parameterType="com.example.mybatistest.entity.User" useGeneratedKeys="true" keyProperty="id">
  11. INSERT INTO <include refid="BASE_TABLE"/>
  12. <trim prefix="(" suffix=")" suffixOverrides=",">
  13. name,password,
  14. <if test="age!=null">
  15. age
  16. </if>
  17. </trim>
  18. <trim prefix=" VALUE(" suffix=")" suffixOverrides=",">
  19. #{name,jdbcType=VARCHAR},#{password},
  20. <if test="age!=null">
  21. #{age}
  22. </if>
  23. </trim>
  24. </insert>
  25. <select id="selectById" resultType="com.example.mybatistest.entity.User">
  26. select
  27. <include refid="BASE_COLUMN"/>
  28. from
  29. <include refid="BASE_TABLE"/>
  30. where id=#{id}
  31. </select>
  32. <select id="selectAll" resultType="com.example.mybatistest.entity.User">
  33. select
  34. <include refid="BASE_COLUMN"/>
  35. from
  36. <include refid="BASE_TABLE"/>
  37. </select>
  38. </mapper>

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

3.测试

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

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

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

​ 编写 UserController.java

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

​ 启动项目,通过 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.

springboot使用Mybatis(xml和注解)全解析的更多相关文章

  1. SpringBoot整合Mybatis【非注解版】

    接上文:SpringBoot整合Mybatis[注解版] 一.项目创建 新建一个工程 ​ 选择Spring Initializr,配置JDK版本 ​ 输入项目名 ​ 选择构建web项目所需的state ...

  2. @Bean 注解全解析

    目录 @Bean 基础声明 @Bean 基本构成及其使用 @Bean 注解与其他注解产生的火花 @Profile 注解 @Scope 注解 @Lazy 注解 @DependsOn 注解 @Primar ...

  3. SpringBoot整合Logback日志框架配置全解析

    目录 本篇要点 一.Logback日志框架介绍 二.SpringBoot与Logback 1.默认日志格式 2.控制台输出 3.文件输出 4.日志级别 5.日志组 6.自定义log配置 三.logba ...

  4. SpringBoot集成Mybatis(0配置注解版)

    Mybatis初期使用比较麻烦,需要各种配置文件.实体类.dao层映射关联.还有一大推其它配置.当然Mybatis也发现了这种弊端,初期开发了generator可以根据表结构自动生成实体类.配置文件和 ...

  5. SpringBoot的外部化配置最全解析!

    目录 SpringBoot中的配置解析[Externalized Configuration] 本篇要点 一.SpringBoot官方文档对于外部化配置的介绍及作用顺序 二.各种外部化配置举例 1.随 ...

  6. SpringBoot整合MyBatis(XML)

    (1).添加依赖 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId> ...

  7. spring-boot整合Mybatis案例(注解方式)

    1.运行环境 开发工具:intellij idea JDK版本:1.8 项目管理工具:Maven 4.0.0 2.GITHUB地址 https://github.com/nbfujx/springBo ...

  8. SpringBoot整合定时任务----Scheduled注解实现(一个注解全解决)

    一.使用场景 定时任务在开发中还是比较常见的,比如:定时发送邮件,定时发送信息,定时更新资源,定时更新数据等等... 二.准备工作 在Spring Boot程序中不需要引入其他Maven依赖 (因为s ...

  9. mybatis开发,你用 xml 还是注解?我 pick ...

    最近在看公司项目时发现有的项目mybatis是基于注解开发的,而我个人的习惯是基于xml文件开发. 对于mybatis注解开发的原理理解不够,于是翻阅了部分源码,写下此文.主要介绍了mybatis开发 ...

随机推荐

  1. Python PyAudio 安装使用

    Python PyAudio安装: Python3.7 无法安装pyaudio pip install pyaudio提示error: Microsoft Visual C++ 14.0 is req ...

  2. Windows Bash on Ubuntu

    windows Bash on Ubuntu, 之前就是尝试一下,更多是在不安装虚拟机的情况下,学下 bash. 这几天,在 上面 make u-boot,这个用起来比 cygwin方便多了. 之前在 ...

  3. poj 1742 多重背包问题 dp算法

    题意:硬币分别有 A1.....An种,每种各有C1......Cn个,问组成小于m的有多少种 思路:多重背包问题 dp[i][j]表示用前i种硬币组成j最多剩下多少个  dp=-1的表示凑不齐 dp ...

  4. SQL_2_查询Select语句的使用

    查询一词在SQL中并不是很恰当,在SQL中查询除了向数据库提出问题之外,还可以实现下面的功能: 1>建立或删除一个表 2>插入.修改.或删除一个行或列 3>用一个特定的命令从几个表中 ...

  5. App架构经验总结

    作者:李纪钢,网名 Keegan小钢,博客地址:http://keeganlee.me.目前在广州日报新媒体有限公司,负责移动产品的研发工作. 关于:本文整理自CSDN架构主题月子活动金牌架构师微课堂 ...

  6. python基础学习笔记——类的成员

    一. 细分类的组成成员 之前咱们讲过类大致分两块区域,如下图所示: 每个区域详细划分又可以分为: class A: company_name = '老男孩教育' # 静态变量(静态字段) __ipho ...

  7. python学习-- 两种方式查看自己的Django版本

    [第一种方式] Windows系统下 按住Windows按键 + R 进入搜索:搜索CMD进入控制台:输入Python进入Python解释器 Linux系统下 直接使用终端调用Python解释器 接下 ...

  8. aiomysql inserting operation failed !

    emotions: those days,i am using aiomysql(python3.5) to acess my database .But a 'strange' problem ma ...

  9. 九度oj 题目1455:珍惜现在,感恩生活

    题目描述: 为了挽救灾区同胞的生命,心系灾区同胞的你准备自己采购一些粮食支援灾区,现在假设你一共有资金n元,而市场有m种大米,每种大米都是袋装产品,其价格不等,并且只能整袋购买.请问:你用有限的资金最 ...

  10. 【转】参照protobuf,将json数据转换成二进制在网络中传输。

    http://blog.csdn.net/gamesofsailing/article/details/38335753?utm_source=tuicool&utm_medium=refer ...