SpringBoot 整合Mybatis (1) 通过Mapper方法调用SQL

通用mapper文档

文件结构目录：
XXXXXXXXXXXXXXXX

pom.xml：

添加mybatis、mysql、mapper、web依赖，这里的mapper和mybatis均会关联jdbc的依赖，所以可以不添加jdbc的依赖。web只是为了方便测试，并非必须。

<?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.bingo</groupId>
    <artifactId>springboot-mybatis</artifactId>
    <version>1.0.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.6.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--mybatis -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>
        <!-- 通用mapper -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>2.0.2</version>
         </dependency>

        <!--jdbc的启动器，默认使用HikariCP连接池-->
<!--        <dependency>-->
<!--            <groupId>org.springframework.boot</groupId>-->
<!--            <artifactId>spring-boot-starter-jdbc</artifactId>-->
<!--        </dependency>-->

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
    </dependencies>


</project>

在resources资源文件夹中添加application.yml：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/springbootmybatis?characterEncoding=UTF-8&useSSL=false
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver

mybatis:
  type-aliases-package: com.demo.pojo

添加实体类：
这里需要一些注解来声明主键，实体类成员变量命名与数据库中存放的一致。这边默认有驼峰命名到下划线命名的这种转换关系，可以参考文档关闭自动转换。一旦有一个不匹配，直接返回错误。
可以通过@Column(name = "数据库内的名字")来注解实体类成员变量，从而实现映射。

package com.demo.pojo;

import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Table(name = "user")
public class User {

    @Id
    @GeneratedValue(strategy= GenerationType.IDENTITY)
    private Integer id;
    private String username;
    private String password;
    private String realname;

    public Integer getId() {
        return id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getRealname() {
        return realname;
    }

    public void setRealname(String realname) {
        this.realname = realname;
    }

    public void setId(Integer id) {
        this.id = id;
    }
}

添加mapper接口：
由于继承了Mapper<T>类，所以已经有很多增删改查的方法可以调用了。

package com.demo.mapper;


import com.demo.pojo.User;
import org.apache.ibatis.annotations.Mapper;


@Mapper
public interface UserMapper extends tk.mybatis.mapper.common.Mapper<User> {

}

添加引导类：
用@MapperScan扫描mapper包下的接口。

package com.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import tk.mybatis.spring.annotation.MapperScan;

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

定义service接口：
定义增删改查的抽象方法。

package com.demo.service;

import com.demo.pojo.User;

import java.util.List;


public interface UserService {

    /**
     * 根据id查询某一个具体的User
     *
     * @param id
     * @return
     */
    User queryById(int id);

    /**
     * 查询全体User信息
     *
     * @return
     */
    List<User> queryAll();

    /**
     * 根据id删除掉某个User
     *
     * @param id
     * @return
     */
    int deleteById(int id);

    /**
     * 更新一个用户信息
     *
     * @param id
     * @param username
     * @param password
     * @param realname
     * @return
     */
    int updateUser(int id, String username, String password, String realname);

    /**
     * 添加一个用户
     *
     * @param username
     * @param password
     * @return
     */
    int insertUser(String username, String password);

}

定义service的实现类：
调用Mapper类里面提供的方法，来执行SQL语句。

package com.demo.service.impl;

import com.demo.mapper.UserMapper;
import com.demo.pojo.User;
import com.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;


    @Override
    public User queryById(int id) {
        return this.userMapper.selectByPrimaryKey(id);
    }

    @Override
    public List<User> queryAll() {
        return this.userMapper.selectAll();
    }

    @Override
    @Transactional
    public int deleteById(int id) {
        return this.userMapper.deleteByPrimaryKey(id);
    }

    @Override
    @Transactional
    public int updateUser(int id, String username, String password, String realname) {
        User user = new User();
        user.setId(id);
        user.setUsername(username);
        user.setPassword(password);
        user.setRealname(realname);
        return this.userMapper.updateByPrimaryKey(user);
    }

    @Override
    @Transactional
    public int insertUser(String username, String password) {
        User user = new User();
        user.setUsername(username);
        user.setPassword(password);
        return this.userMapper.insert(user);
    }
}

写controller层进行测试：

package com.demo.controller;

import com.demo.pojo.User;
import com.demo.service.impl.UserServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;


// 用于测试
@RestController
@RequestMapping("user")
public class UserController {

    @Autowired
    private UserServiceImpl userServiceImpl;

    // select
    @RequestMapping(value = "/all", method = RequestMethod.GET)
    public List<User> getAllUsers() {
        return userServiceImpl.queryAll();
    }

    // select
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    public User getUserById(@PathVariable("id") int id) {
        return userServiceImpl.queryById(id);
    }

    // update
    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
    public String updateAccount(@PathVariable("id") int id,
                                @RequestParam(value = "username", required = true) String username,
                                @RequestParam(value = "password", required = true) String password,
                                @RequestParam(value = "realname", required = true) String realname) {
        int t = userServiceImpl.updateUser(id, username, password, realname);
        if (t == 1) {
            return "success";
        } else {
            return "fail";
        }

    }

    // delete
    @RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
    public String delete(@PathVariable(value = "id") int id) {
        int t = userServiceImpl.deleteById(id);
        if (t == 1) {
            return "success";
        } else {
            return "fail";
        }

    }

    // post
    @RequestMapping(value = "", method = RequestMethod.POST)
    public String postAccount(@RequestParam(value = "username") String username,
                              @RequestParam(value = "password") String password) {

        int t = userServiceImpl.insertUser(username, password);
        if (t == 1) {
            return "success";
        } else {
            return "fail";
        }

    }


    @GetMapping("hello")
    public String test() {
        return "hello mybatis";
    }
}

通过postman测试成功。

补充说明：

一些注解：

Mybatis中用到的注解：

在实体类中：命名最好与数据库一致，注意userName这种小驼峰命名，会被解析成user_name来执行SQL语句。
1、表名

@Table(name = "tb_user")

1、修饰id主键，没有注解的话会使得Mapper<T>里的方法无法使用。但是如果用的是其他方法来执行SQL语句，则没有关系。

@Id
@GeneratedValue(strategy= GenerationType.IDENTITY)

2、用户名

@Length(min = 4,max = 15,message = "用户名只能在4~15位之间")

3、密码

@JsonIgnore
@Length(min = 6,max = 25,message = "密码只能在6~25位之间")

4、手机号

@Pattern(regexp = "^1[35678]\\d{9}$", message = "手机号格式不正确")

package com.leyou.user.pojo;

import com.fasterxml.jackson.annotation.JsonIgnore;
import org.hibernate.validator.constraints.Length;

import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.validation.constraints.Pattern;
import java.util.Date;

/**
 * @Author: 98050
 * @Time: 2018-10-21 18:42
 * @Feature: 用户实体类
 */
@Table(name = "tb_user")
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    /**
     * 用户名
     */
    @Length(min = 4,max = 15,message = "用户名只能在4~15位之间")
    private String username;

    /**
     * 密码
     */
    @JsonIgnore
    @Length(min = 6,max = 25,message = "密码只能在6~25位之间")
    private String password;

    /**
     * 电话
     */
    @Pattern(regexp = "^1[35678]\\d{9}$", message = "手机号格式不正确")
    private String phone;

    /**
     * 创建时间
     */
    private Date created;

    //Getter和Setter
    //.......................

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", phone='" + phone + '\'' +
                ", created=" + created +
                '}';
    }
}

@Transactional

声明是 Spring 的事务管理，用的必须是jdbctemplate, jpa, mybatis，这种常见的orm。

@Transient

表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性.

@MapperScan("com.demo.mapper")

加入引导类，用于扫描mapper包下的Mapper类，加入到IoC容器中。

@org.apache.ibatis.annotations.Mapper

用于mapper类，声明这是一个Mapper接口

SQL方法：

增：

int insert(T t)
int insertSelective(T t):Selective表示不必完整地给实体类赋值
insertSelective和insert的区别？

删：

int delete(T t)
int deleteByExample(object o)
int deleteByPrimaryKey(Object id)

查：

T selectByPrimaryKey(object id)：根据主键查找实体T，在实体类定义的时候必须添加@Id声明主键
List<T> select(T t)
List<T> selectAll()
List<T> selectByExample(Objcet o)
List<T> selectByExampleAndRowBounds(Object o, ssss)
List<T> selectByRowBounds(T t, xxxx)
T selectOne(T t)
T selectOneByExample(Object o)
int selectCount(T t)
int selectCountByExample(Object o)

改：

int updateByExample(T t, Object o)
int updateByExampleSelective(T t, Object o)
int updateByPrimaryKey(T t)
int updateByPrimaryKeySelective(T t)

其他：

boolean existsWithPrimaryKey(object o)

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 158,233评论 4赞 360
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,013评论 1赞 291
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 108,030评论 0赞 241
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 43,827评论 0赞 204
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,221评论 3赞 286
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,542评论 1赞 216
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,814评论 2赞 312
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,513评论 0赞 198
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,225评论 1赞 241
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,497评论 2赞 244
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,998评论 1赞 258
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,342评论 2赞 253
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 32,986评论 3赞 235
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,812评论 0赞 194
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,560评论 2赞 271
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,461评论 2赞 266

推荐阅读更多精彩内容