IDEA+SpingBoot整合mybatis搭建

最新推荐文章于 2023-03-22 21:04:04 发布

有个机车梦

最新推荐文章于 2023-03-22 21:04:04 发布

阅读量247

点赞数 1

分类专栏： Spring-boot Mybatis 模板

本文链接：https://blog.csdn.net/Yuz_99/article/details/98721786

版权

Mybatis 同时被 3 个专栏收录

33 篇文章 1 订阅

订阅专栏

Spring-boot

31 篇文章 0 订阅

订阅专栏

模板

2 篇文章 0 订阅

订阅专栏

本文档详细介绍了如何在IDEA中利用SpringBoot整合Mybatis进行项目搭建，包括创建项目、修改POM文件、配置数据库、编写配置文件、创建实体类、service、dao、controller以及Swagger文件，最后启动项目并测试API接口。

摘要由CSDN通过智能技术生成

1 创建项目

在这里插入图片描述

删除不必要的文件

2 查看默认的pom文件添加内容

默认的POM文件

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.8.BUILD-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com</groupId>
    <artifactId>mybatis_test2</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>mybatis_test2</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--mybaits-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.0</version>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </repository>
        <repository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </pluginRepository>
        <pluginRepository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>

</project>

我们在添加swagger2的配置

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!--swagger-->

在4 编写配置文件中

POM文件有一块地方是需要修改的，在mysql驱动那里，我在这里提前修改了，在4还是会提及一下。

注意：将mysql驱动配置中的scope修改成version （版本可自己定义）

        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>

为什么scope定义为runtime无法识别呢？
在POM 4中，中还引入了，它主要管理依赖的部署。目前可以使用5个值：
* compile，缺省值，适用于所有阶段，会随着项目一起发布。
* provided，类似compile，期望JDK、容器或使用者会提供这个依赖。如servlet.jar。
* runtime，只在运行时使用，如JDBC驱动，适用运行和测试阶段。
* test，只在测试时使用，用于编译和运行测试代码。不会随项目发布。
* system，类似provided，需要显式提供包含依赖的jar，Maven不会在Repository中查找它。

runtime只有在运行时使用，所以导致前面url爆红无法识别。

最终的POM文件内容：

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.8.BUILD-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com</groupId>
    <artifactId>mybatis_test2</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>mybatis_test2</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--mybaits-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.0</version>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!--swagger-->
        
        <!--test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </repository>
        <repository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </pluginRepository>
        <pluginRepository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>

</project>

3 新建数据库

CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) DEFAULT NULL,
  `address` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

在这里插入图片描述

4 编写配置文件

将properties改成yml文件，yml文件相比与properties 它是一层一层的编写的！！
在这里插入图片描述
发现这里爆红

我们打开配置pom：

注意：将scope修改成version

        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>

在这里插入图片描述
在yml文件中继续添加mybatis的配置内容

mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.entity

mapper-locations: 指代的是mapper文件的配置
-classpath：代表的是resources文件下的路径
-classpath:mapper/*.xml：指resources文件底下有个mapper文件夹下的所有.xml文件都是mapper文件
type-aliases-package: 指代的是实体类对应的位置
-com.entity: 指的是src/main/java/com/entity包下的所有.java类

在这里插入图片描述

最终application.yml文件的内容是:

spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/user?useUnicode=true&characterEncoding=utf8&useSSL=false
    username: root
    password: 123456

mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.entity

5 编写实体类，service，dao，controller，swagger文件

在application.yml文件中，我们写了mapper的位置，和实体类在哪个包，我们先创建。
在这里插入图片描述

5.0 entity

@Data
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
public class User {

    private Integer id;
    private String name;
    private String address;

}

5.1 dao & mapper

package com.dao;
@Mapper
public interface UserDao {

    User selectById(Integer id);

    List<User> selectByMap(Map<String,Object> map);

    int insert(User user);

    int deleteById(Integer id);

    int updateById(User user);
}

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.dao.UserDao">
    <resultMap id="userMap" type="com.entity.User">
        <id property="id" column="id"/>
        <result property="name" column="name"/>
        <result property="address" column="address"/>
    </resultMap>


    <insert id="insert" parameterType="User"
            useGeneratedKeys="true" keyColumn="id" keyProperty="id">
        INSERT INTO user
        (
        name,address
        )
        VALUES
        (
        #{name},#{address}
        )
    </insert>

    <delete id="deleteById">
        delete
        from user
        where
        id=#{id}
    </delete>

    <update id="updateById" parameterType="User">
        update user
        <set>
            <if test="name!=null">name=#{name},</if>
            <if test="address!=null">address=#{address}</if>
        </set>
        where id=#{id}
    </update>

    <select id="selectById" resultMap="userMap">
        select *
        from user
        where
        id=#{id}
    </select>

    <select id="selectByMap" resultMap="userMap" parameterType="java.util.Map">
        select *
        from user
        <where>
            <if test="name!=null">name=#{name}</if>
            <if test="address!=null">and address=#{address}</if>
        </where>
    </select>


</mapper>

5.2 service

@Service
@Transactional(rollbackFor = Exception.class)
public class UserService {
    @Autowired
    UserDao userDao;

    /**
     * @Description: 添加
     * @Author: Yuz
     * @Date: 2019/9/15
     */
    public void insert(User user){
        userDao.insert(user);
    }
    /**
     * @Description: 删除
     * @Author: Yuz
     * @Date: 2019/9/15
     */
    public void delete(Integer id){
        userDao.deleteById(id);
    }
    /**
     * @Description: 更新
     * @Author: Yuz
     * @Date: 2019/9/15
     */
    public void update(User user){
        userDao.updateById(user);
    }
    /**
     * @Description: 查询名称为123的User
     * @Author: Yuz
     * @Date: 2019/9/15
     */
    public List<User> selectByMap(){
        Map<String,Object> map = new HashMap<>();
        map.put("name",123);
        return userDao.selectByMap(map);
    }
    /**
     * @Description:
     * @Author: Yuz
     * @Date: 2019/9/15
     */
    public User selectById(Integer id){
        return userDao.selectById(id);
    }
}

5.3 swagger

package com.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@EnableSwagger2
@Configuration
public class Swagger {
        /**
         * 创建API应用
         * apiInfo() 增加API相关信息
         * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
         * 本例采用指定扫描的包路径来定义指定要建立API的目录。
         *
         * @return
         */
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
        /**
         * 创建该API的基本信息（这些基本信息会展现在文档页面中）
         * 访问地址：http://项目实际地址/swagger-ui.html
         * @return
         */
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("User接口")
                    .description("User接口#")
                    .termsOfServiceUrl("http://localhost:8080   Yuz")
                    .version("1.0")
                    .build();
        }
    }

5.4 controller

@RestController
@RequestMapping("/user")
@Api("用户接口")
public class UserController {
    @Autowired
    UserService userService;

    @PostMapping("/insert")
    @ApiOperation(value = "用户添加")
    public void insert(@RequestBody User user){
        userService.insert(user);
    }

    @DeleteMapping("/delete")
    @ApiOperation(value = "删除")
    public void delete(Integer id){
        userService.delete(id);
    }

    @PutMapping
    @ApiOperation(value = "更新")
    public void update(@RequestBody User user){
        userService.update(user);
    }

    @GetMapping
    @ApiOperation("查询")
    public List<User> select(){
        return userService.selectByMap();
    }

}

最终创建完的目录结构：

在这里插入图片描述

6 配置专属的mapper文件

自动配置专属我们的mapper文件创建路径

复制里面的内容
在这里插入图片描述
粘贴，自己命名

在这里插入图片描述

7 编写配置文件UserMapper

在这里插入图片描述
注意: 这里要明确指出Dao的位置；

<mapper namespace="com.dao.UserDao">
    <resultMap id="userMap" type="com.entity.User">
        <id property="id" column="id"/>
        <result property="name" column="name"/>
        <result property="address" column="address"/>
    </resultMap>


    <insert id="insert" parameterType="User"
    useGeneratedKeys="true" keyColumn="id" keyProperty="id">
        INSERT INTO user
        (
        name,address
        )
        VALUES
        (
        #{name},#{address}
        )
    </insert>

    <delete id="deleteById">
        delete
        from user
        where
        id=#{id}
    </delete>

    <update id="updateById" parameterType="User">
        update user
        <set>
            <if test="name!=null">name=#{name},</if>
            <if test="address!=null">address=#{address}</if>
        </set>
        where id=#{id}
    </update>

    <select id="selectById" resultMap="userMap">
        select *
        from user
        where
        id=#{id}
    </select>

    <select id="selectByMap" resultMap="userMap" parameterType="java.util.Map">
        select *
        from user
        <where>
            <if test="name!=null">name=#{name}</if>
            <if test="address!=null">and address=#{address}</if>
        </where>
    </select>


</mapper>

推荐大家下一个插件，具体用途和下载自行百度。
Free Mybaits plugin

在这里插入图片描述

8 启动项目。

打开页面访问： http://localhost:8080/swagger-ui.html

swagger的具体用法自己去百度吧，我只简单的介绍一下。

在这里插入图片描述
把id字段给删除了。

打开数据库查看是否插入数据。
在这里插入图片描述

有个机车梦

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
IDEA+SpingBoot整合mybatis搭建

1 创建项目删除不必要的文件2 查看默认的pom文件添加内容默认的POM文件<?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"...
复制链接

扫一扫