欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

SpringBoot 集成Mybatis入门Demo(亲测可用)

程序员文章站 2022-05-26 08:50:24
...

SpringBoot 集成Mybatis入门Demo(亲测可用)

记录一下第一次使用springBoot 集成Mybatis的入门demo,虽然网上相关博客挺多,但是或多或少总会有些小问题,导致跟我一样的小白一脸懵逼,好了废话不多说,开始。。。

第一步:新建springBoot 项目(使用IDEA)

  1. 使用idea创建新的springBoot项目,如果当前已打开一个项目,可依次点击File–>close project来关闭当前的项目,回到如下界面:
    SpringBoot 集成Mybatis入门Demo(亲测可用)
  2. 点击【Create New Project】,打开项目新建窗口,选择Spring Initializr,如下图:
    SpringBoot 集成Mybatis入门Demo(亲测可用)
  3. 点击【Next】,进入项目的基本信息设置界面,可保持默认配置,我这里简单修改下,如下图:
    SpringBoot 集成Mybatis入门Demo(亲测可用)
  4. 按照上面的设置完成后,点击【Next】进入下一步,选择项目依赖,在此我们先选择一个Spring Web依赖,如下图:

SpringBoot 集成Mybatis入门Demo(亲测可用)
3. 继续点击【Next】,进行项目名称的设置,设置完成后点击【Finish】即可。
SpringBoot 集成Mybatis入门Demo(亲测可用)
项目创建后,会展示以下的项目结构,为了展示结构的层级关系,这里取消了"Flatten Packages"的设置:
SpringBoot 集成Mybatis入门Demo(亲测可用)

第二步:添加Mybatis框架的相关依赖

打开项目中的pom.xml文件,在…标签中间添加mybatis的相关依赖,如下图:

<dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>1.3.2</version>
</dependency>
<dependency>
       <groupId>mysql</groupId>
       <artifactId>mysql-connector-java</artifactId>
       <scope>runtime</scope>
 </dependency>

SpringBoot 集成Mybatis入门Demo(亲测可用)

第三步:添加application.yml、application-dev.yml配置文件

删除src/main/resource下的application.proterties文件,并新增application.yml、application-dev.yml两个文件,文件内容分别为:
application.yml

spring:
  profiles:
    active: dev

application-dev.yml(注意:将连接数据库的用户名、密码以及数据库名改成你自己的)

server:
  port: 8080
 
spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/springboot?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
    driver-class-name: com.mysql.jdbc.Driver
 
mybatis:
  mapper-locations: classpath:/mapper/**/*.xml
  type-aliases-package: com.test.modules.*.entity
 
#showSql
logging:
  level:
    com:
      example:
        mapper : debug

第四步:启动测试

上述步骤完成后,可以点击运行,测试项目是否可正常运行,如下为正常运行的提示:
SpringBoot 集成Mybatis入门Demo(亲测可用)

第五步:先创建一个不需要访问数据库的controller

  1. 在modules目下新建一个controller的目录,并在新建的目录下创建一个HelloController类,如下:
    HelloController.java
package com.test.modules.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @RequestMapping("/hello")
    public String helloWord(){
        return "hello world";
    }
}

SpringBoot 集成Mybatis入门Demo(亲测可用)
2. 启动项目,并在浏览器中输入http://localhost:8080/hello,可成功返回"hello world"信息:
SpringBoot 集成Mybatis入门Demo(亲测可用)

第六步:使用Mybatis框架,访问数据库获取信息

  1. 创建数据库表
    在配置application-dev.yml文件时,已经用mysql数据库创建了一个springboot的数据库,在该数据库下新建一个user表,表结构如下:
CREATE TABLE `user` (
  `id` INT(32) NOT NULL AUTO_INCREMENT,
  `userName` VARCHAR(32) NOT NULL,
  `passWord` VARCHAR(50) NOT NULL,
  `realName` VARCHAR(32) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=INNODB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;

根据自己的需求,在表中随便插入几条数据即可。
2. 创建目录结构
随着业务需求的增加,后期业务可能非常多,为了便于管理,将不同模块的业务代码全部放在modules目录下,如:先创建一个user目录(包含对用户信息相关的操作),在user目录下分别创建controller、entity、service、dao几个目录,对应也需要在main/resource目录下创建mapper目录,并在该目录下创建user目录,创建完后的目录结构为:
SpringBoot 集成Mybatis入门Demo(亲测可用)
3. 编写实体类
在entity目录下新建User类,代码如下:

package com.test.modules.user.entity;

public class User {
    private Integer id;
    private String userName;
    private String passWord;
    private String realName;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = 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;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", userName='" + userName + '\'' +
                ", passWord='" + passWord + '\'' +
                ", realName='" + realName + '\'' +
                '}';
    }
}
  1. 编写映射类
    在dao目录下创建UserDao接口(注意:此处是创建接口不是类),进行java对象和数据库记录之间的映射。
    UserDao.java的代码如下:
package com.test.modules.user.dao;

import com.test.modules.user.entity.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserDao {
    User getUserById(int id);
}

对应的需要在main/resources/mapper/user目录下创建对应的userMapper.xml配置文件(注意:namespace和resultType的路径不要写错了),如下:

<?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.test.modules.user.dao.UserDao">
    <select id="getUserById" resultType="com.test.modules.user.entity.User">
        select * from user where id = #{id}
    </select>
</mapper>
  1. 编写业务层代码
    在modules/service目录下创建UserService类,代码如下:
package com.test.modules.user.service;

import com.test.modules.user.dao.UserDao;
import com.test.modules.user.entity.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Autowired
     UserDao userDao;

    public User getUserById(int id){
        return userDao.getUserById(id);
    }

}

上述代码编写完成后,idea会提示无法自动注入的报错信息,两种解决办法:
第一种:可以选择忽视,程序可正常运行;
第二种:在UserDao中添加@Repository注解,将其申明为一个java Bean即可;
SpringBoot 集成Mybatis入门Demo(亲测可用)
6. 编写控制器代码
在user/controller目录下创建UserController类,代码如下:

package com.test.modules.user.controller;

import com.test.modules.user.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;

    @RequestMapping("/getUserById/{id}")
    public String getUserById(@PathVariable int id){
        return userService.getUserById(id).toString();
    }
}
  1. 启动项目进行测试
    上述代码编写完成后,启动项目,在浏览器中输入http://127.0.0.1:8080/user/getUserById/1,即可获取数据库中的信息。
    SpringBoot 集成Mybatis入门Demo(亲测可用)
    SpringBoot 集成Mybatis入门Demo(亲测可用)
    好了,今天先写到这里,后面再进行完善和补充吧:)