IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解

我就是我 2023-10-18 16:58 4阅读 0赞

用**IntelliJ IDEA**搭建一个java 的API接口项目。

**IntelliJ IDEA下载地址：**[https://www.jetbrains.com/idea/download/\#section=windows][https_www.jetbrains.com_idea_download_section_windows]

**最终效果图展示：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70][]

**整体目录结构：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 1][]

**1.创建一个maven项目**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 2][]

如图，新建项目里面选择Maven，然后Next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 3][]

输入groupid和artifactid，然后Next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 4][]

直接finish。一个maven项目创建好了。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 5][]

**2.创建目录结构，引入pom依赖**

<parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.8.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
        </dependencies>

目录结构：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 6][]

创建配置文件：application.yml和application-dev.yml

application.yml文件内容： 配置服务端口，不配置默认8080

# 配置端口
    server:
      port: 6688
    spring:
      profiles:
    #  配置的环境
        active: dev

**3.接下来，配置mybatis**

3.1先引入pom依赖

<dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.1</version>
            </dependency>

3.2 将mybatis配置添加进application.yml

# mybatis 配置
    mybatis:
      config-location: classpath:mybatis/mybatis-config.xml
      mapper-locations: classpath:mybatis/mapper/*.xml

因为之前配置application.yml用的是dev的环境配置，所以这里在dev配置文件中添加数据库连接信息同时添加mysql依赖

<dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>

spring:
      datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://数据库服务器地址/studb?useUnicode=true&characterEncoding=utf-8
        username: write
        password: write123

3.3引入数据库自动映射工具依赖

<build>
            <plugins>
                <plugin>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-maven-plugin</artifactId>
                    <version>1.3.2</version>
                    <configuration>
                        
                        
                        <verbose>true</verbose>
                        
                        <overwrite>true</overwrite>
                    </configuration>
                    <dependencies>
                        <dependency>
                            <groupId>org.mybatis.generator</groupId>
                            <artifactId>mybatis-generator-core</artifactId>
                            <version>1.3.2</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>
        </build>

再配置文件中添加工具XML。。。。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 7][]

generatorConfig.xml 内容：

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE generatorConfiguration
            PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
            "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
    <generatorConfiguration>
        <classPathEntry location="D:/mysql-connector-java-5.1.34.jar"/>
    
        <context id="my" targetRuntime="MyBatis3" defaultModelType="flat">
    
            <commentGenerator>
                <property name="suppressAllComments" value="true"/>
            </commentGenerator>
    
            
            <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                            connectionURL="jdbc:mysql://这里是数据库服务器地址/studb?characterEncoding=utf8"
                            userId="write"
                            password="write123">
            </jdbcConnection>
    
    
            <javaTypeResolver>
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="com.test.apitestpro.domain.entity"
                                targetProject="D:\javamybatis">
                <property name="enableSubPackages" value="true"/>
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="com.test.apitestpro.domain"
                             targetProject="D:\javamybatis">
                <property name="enableSubPackages" value="true"/>
            </sqlMapGenerator>
    
            
            <javaClientGenerator type="XMLMAPPER"
                                 targetPackage="com.test.apitestpro.domain.mapper"
                                 targetProject="D:\javamybatis">
                <property name="enableSubPackages" value="true"/>
            </javaClientGenerator>
    
            
            <table tableName="StudentInfo"
                   domainObjectName="StudentInfoEntity"
                   enableCountByExample="false" enableUpdateByExample="false"
                   enableDeleteByExample="false" enableSelectByExample="false"
                   selectByExampleQueryId="false">
                <property name="useActualColumnNames" value="true"/>
            </table>
    
        </context>
    
    </generatorConfiguration>

targetProject 配置的文件生成地址，配置完成后即可执行工具。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 8][]

点击运行。。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 9][]

生成成功。然后到配置地址获取生成内容。拷贝至项目中对应位置

![20190412163734252.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 10][]

到这里一个springboot+mybatis项目搭建完成了，接下来接下来就是添加swagger。。。

**4.添加swagger工具**

4.1 添加swagger依赖

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

4.2 添加swagger类

![20190415093541731.png][]

package com.test.apitestpro.controller;
    
    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;
    
    @Configuration
    @EnableSwagger2
    public class Swagger {
        @Bean
        public Docket helloApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.test.apitestpro.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("api文档")
                    .description("搭建spring boot+mybatis+maven+swagger的测试项目")
                    .termsOfServiceUrl("http://接口IP")
                    .version("v1")
                    .build();
        }
    }

现在就可以愉快的撸业务代码了，一个接口项目就搭建完成了。。。

项目demo可以在这里获取:[https://github.com/lrx13558703/-IDEA-java-][https_github.com_lrx13558703_-IDEA-java-]

[https_www.jetbrains.com_idea_download_section_windows]: https://www.jetbrains.com/idea/download/#section=windows
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190415094405458.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20190415094631410.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20190412112422698.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20190412113223804.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20190412113418794.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20190412113720147.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20190412154956124.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20190412162855159.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20190412163542991.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 9]: https://img-blog.csdnimg.cn/20190412163638470.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[20190412163734252.png]: https://img-blog.csdnimg.cn/20190412163734252.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5_size_16_color_FFFFFF_t_70 10]: https://img-blog.csdnimg.cn/20190412164633143.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjczMDA5,size_16,color_FFFFFF,t_70
[20190415093541731.png]: https://img-blog.csdnimg.cn/20190415093541731.png
[https_github.com_lrx13558703_-IDEA-java-]: https://github.com/lrx13558703/-IDEA-java-