springboot整合mybatis（一）入门

xiatianit

已于 2024-12-24 14:56:39 修改

阅读量2.5k

点赞数 21

分类专栏： Mybatis 文章标签： mybatis

于 2022-03-23 17:13:32 首次发布

本文链接：https://blog.youkuaiyun.com/xiatianit/article/details/123689757

版权

Mybatis 专栏收录该内容

8 篇文章

订阅专栏

创建springboot项目，保证能正常启动

springboot的创建略

引入依赖

配置jdbc驱动依赖

在项目的 pom.xml 中引入连接数据库的依赖，示例代码如下。

       <!-- JDBC驱动-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jdbc</artifactId>
            <version>2.6.4</version>
        </dependency>
        <!--导入数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.13</version>
        </dependency>

配置mybatis依赖

在项目的 pom.xml 中引入 mybatis-spring-boot-starter 的依赖，示例代码如下。

        <!--引入 mybatis-spring-boot-starter 的依赖-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.0</version>
        </dependency>

配置application.properties/yml文件

在 Spring Boot 的配置文件（application.properties/yml）中对 mysql数据库连接进行配置示例代码如下。
在 Spring Boot 的配置文件（application.properties/yml）中对 MyBatis 进行配置，例如指定 mapper.xml 的位置、实体类的位置、是否开启驼峰命名法等等，示例代码如下。

##################################### 数据源连接信息 ########################
spring:
  datasource:
    username: root
    password: root
    #MYSQL6.X版本的url 别忘了加上时区
    url: jdbc:mysql://127.0.0.1:3306/hxzy?autoReconnect=true&useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&useSSL=false&useTimezone=true&serverTimezone=UTC
    driver-class-name: com.mysql.cj.jdbc.Driver   


 

###################################### MyBatis 配置######################################
mybatis:
  # 指定 mapper.xml 的位置
  mapper-locations: classpath:mybatis/mapper/*.xml
  #扫描实体类的位置,在此处指明扫描实体类的包，在 mapper.xml 中就可以不写实体类的全路径名
  type-aliases-package: com.example.demo27.bean
  configuration:
    #默认开启驼峰命名法，可以不用设置该属性
    map-underscore-to-camel-case: true

创建实体

在指定的数据库内创建一个 user 表，并插入一些数据，如下表。

根据数据库sys_user表，创建User实体，代码如下

 
DROP TABLE IF EXISTS `sys_user`;
CREATE TABLE `sys_user`  (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `username` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  `password` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  `icon` varchar(500) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '头像',
  `email` varchar(100) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '邮箱',
  `nick_name` varchar(200) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '昵称',
  `note` varchar(500) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '备注信息',
  `create_time` datetime NULL DEFAULT NULL COMMENT '创建时间',
  `login_time` datetime NULL DEFAULT NULL COMMENT '最后登录时间',
  `status` int(1) NULL DEFAULT 1 COMMENT '帐号启用状态：0->禁用；1->启用',
  `supply_id` int(20) NULL DEFAULT NULL COMMENT '供应商',
  `store_id` bigint(11) NULL DEFAULT 1 COMMENT '所属店铺',
  `store_name` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 513 ;
 
INSERT INTO `sys_user` VALUES (2, 'admin', '$2a$10$4eDuF3pka0gA1c7OS1wRz.5GN9gQKlo7LX1Mfn3wkg2u4MladxsAK', 'http://macro-oss.oss-cn-shenzhen.aliyuncs.com/mall/images/20190129/170157_yIl3_1767531.jpg', 'admin@163.com', '系统管理员', '系统管理员', '2018-10-08 13:32:47', '2019-04-05 11:31:38', 1, 1, 1, '一家花店');
INSERT INTO `sys_user` VALUES (511, 'test', '$2a$10$m4WlZDOvkIQ8eIQD7..zWO7CAXgPKGJ/WP5UuT8wtXgx9/O758v6q', NULL, NULL, 'test', NULL, '2021-02-15 09:06:15', NULL, 1, NULL, 1, NULL);
INSERT INTO `sys_user` VALUES (512, 'zs', '$2a$10$4NA8jNfWfjVWX/Bvy65jz.iqWbou5mHfjrQtW9YyH4PY8nTKNeQZa', NULL, NULL, 'zs', NULL, '2022-01-09 10:48:34', NULL, 1, NULL, 1, NULL);
 
SET FOREIGN_KEY_CHECKS = 1;

package com.example.demo27.bean;

public class User {
    private Integer id;

    private String userId;

    private String username;

    private String password;

    private String email;

    private String nickName;

    public Integer getId() {
        return id;
    }

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

    public String getUserId() {
        return userId;
    }

    public void setUserId(String userId) {
        this.userId = userId;
    }

    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 getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getNickName() {
        return nickName;
    }

    public void setNickName(String nickName) {
        this.nickName = nickName;
    }
}

创建Mapper接口

在 com.example.demo27.mapper中创建一个 UserMapper 接口，并在该类上使用 @Mapper 注解，代码如下。

注意：当 mapper 接口较多时，我们可以在 Spring Boot 主启动类上使用 @MapperScan 注解扫描指定包下的 mapper 接口，而不再需要在每个 mapper 接口上都标注 @Mapper 注解。

package com.example.demo27.mapper;

import org.apache.ibatis.annotations.Mapper;
import com.example.demo27.bean.User;
/**
 * @Author zhaox
 * @Date 22/3/23
 */


@Mapper
public interface UserMapper {
    //通过用户名密码查询用户数据
    User getByUserNameAndPassword(User user);
}

创建Mapper映射文件

参照配置文件 application.properties/yml中关于mapper的配置；在resource目录下创建文件夹和映射文件；如：mybatis/mapper/UserMapper.xml，代码如下。

说明：

使用 Mapper 进行开发时，需要遵循以下规则：

mapper 映射文件中 namespace 必须与对应的 mapper 接口的完全限定名一致。
mapper 映射文件中 statement 的 id 必须与 mapper 接口中的方法的方法名一致
mapper 映射文件中 statement 的 parameterType 指定的类型必须与 mapper 接口中方法的参数类型一致。
mapper 映射文件中 statement 的 resultType 指定的类型必须与 mapper 接口中方法的返回值类型一致。

<?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.demo27.mapper.UserMapper">
    <resultMap id="BaseResultMap" type="com.example.demo27.bean.User">
            <id column="id" jdbcType="INTEGER" property="id"/>
        <result column="username" jdbcType="VARCHAR" javaType="java.lang.String"  property="username"/>
        <result column="password" jdbcType="VARCHAR" property="password"/>
        <result column="email" jdbcType="VARCHAR" property="email"/>
        <result column="nick_name" jdbcType="VARCHAR" property="nickName"/>
    </resultMap>

    <sql id="Base_Column_List">
        id, user_id, user_name, password, email
    </sql>
    <!--根据用户名密码查询用户信息-->
    <!--application.yml 中通过 type-aliases-package 指定了实体类的为了，因此-->
    <select id="getByUserNameAndPassword" resultType="com.example.demo27.bean.User">
        SELECT
            *
        FROM
            sys_user
        WHERE
            id =2
    </select>
</mapper>

创建Services

在项目中 com.example.demo27.service 包中创建一个名为 UserService 的接口，代码如下。

package com.example.demo27.service;

import com.example.demo27.bean.User;

/**
 * @Author zhaox
 * @Date 22/3/23
 */ 
public interface UserService {
    public User getByUserNameAndPassword(User user);
}

service实现类

com.example.demo27.service.impl 包中创建 UserService 接口的实现类，并使用 @Service 注解将其以组件的形式添加到容器中，代码如下。

注意： @Service（"userService”）注解容易忘记

package com.example.demo27.service.impl;

/**
 * @Author zhaox
 * @Date 22/3/23
 */ 
import com.example.demo27.bean.User;
import com.example.demo27.mapper.UserMapper;
import com.example.demo27.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service("userService")
public class UserServiceImpl implements UserService {
    @Autowired
    UserMapper userMapper;


    @Override
    public User getByUserNameAndPassword(User user) {
        User loginUser = userMapper.getByUserNameAndPassword(user);
        return loginUser;
    }
}

com.example.demo27.controller包下创建LoginController访问接口

package com.example.demo27.controller;

/**
 * @Author zhaox
 * @Date 22/3/23
 */
import com.example.demo27.bean.User;
import com.example.demo27.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpSession;
import java.util.Map;


@RestController
public class UserController {
    @Autowired
    UserService userService;


    @RequestMapping("/user/single")
    public User doLogin(User user, Map<String, Object> map, HttpSession session) {
        //从数据库中查询用户信息
        User loginUser = userService.getByUserNameAndPassword(user);
        return loginUser;

    }
}

测试浏览器输入访问地址

http://localhost:8080/user/single