Spring Boot工程demo

最新推荐文章于 2025-04-17 16:51:17 发布

原创最新推荐文章于 2025-04-17 16:51:17 发布 · 269 阅读

0 ·

CC 4.0 BY-SA版权

java 专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何在SpringBoot项目中集成MyBatis进行数据库操作，并利用Swagger实现API文档自动生成。涵盖依赖配置、数据库连接配置、MyBatis接口定义及Lombok简化代码等内容。

目标：

1 建立一个spring boot demo

2 包含swagger导出功能

3 通过mybatis访问数据库

步骤：

1 通过idea建立一个spring boot工程，注意pom要添加依赖如下：否则无法启动

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

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

2 配置application.properties文件

#设置Tomcat端口，默认8080
server.port=8080
#设置项目ContextPath
server.context-path=/
#设置Tomcat编码
server.tomcat.uri-encoding=UTF-8

#数据库配置，自动会产生DataSource，不需要额外操作
spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true
spring.datasource.username=root
spring.datasource.password=admin
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

3 添加mybatis的依赖在pom中

在创建工程的时候，有选项可以自动添加该依赖

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

4 mybatis可以通过注解配置，不需要写mapper的xml文件

只需要在Dao接口中添加@Mapper即可，例如：

@Mapper
public interface UserDao {

    @Select("select * from user where id=#{id}")
    @Results({@Result(property="id", column="id"),
            @Result(property="name", column="name")})
    User getNameById(@Param("id")  Integer id);

    @Insert("insert into user(id,name) values(#{id},#{name})")
    void save(User user);
}

这样就可以了，后面service层直接通过上面的接口访问数据库即可，不需要做额外操作，

和Spring Data JPA一样方便。

上面的数据库访问接口中的User是model层中的数据，定义如下：

@Data

@NoArgsConstructor
@ApiModel(value="医生对象模型")
public class User {

    public Integer id;

    public String name;
}

5 添加lombok库

该库的作用是，在pojo类中需要添加许多set，get代码，该库可以自动生成，上面的@Data注解就是干这件事的。

<dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <optional>true</optional>
</dependency>

6 集成swagger

<dependency>

   <groupId>io.springfox</groupId>

   <artifactId>springfox-swagger2</artifactId>

   <version>2.2.2</version>

</dependency>

<dependency>

   <groupId>io.springfox</groupId>

   <artifactId>springfox-swagger-ui</artifactId>

   <version>2.2.2</version>

</dependency>

编写配置类

@Configuration
@EnableSwagger2
public class Swagger2 {

    //通过http://localhost:8080/swagger-ui.html访问api文档

    /**
     * 创建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.example.demo.controller"))//该包名必须正确
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("更多请关注http://www.baidu.com")
                .termsOfServiceUrl("http://www.baidu.com")
                .contact("sunf")
                .version("1.0")
                .build();
    }

}

参考：https://blog.youkuaiyun.com/sanyaoxu_2/article/details/80555328

7 数据库自动升级库liquibase

程序中数据库需要自动升级，创建新表，增加新列，可通过该库完成；

通过两步完成配置：

1 编写配置类：

@Configuration
public class LiquibaseConfig {

    @Autowired
    private DataSource dataSource;

    @Bean
    public SpringLiquibase liquibase(DataSource dataSource) {
        SpringLiquibase liquibase = new SpringLiquibase();
        liquibase.setDataSource(dataSource);
        liquibase.setChangeLog("classpath:master.xml");
        liquibase.setContexts("development,test,production");
        liquibase.setShouldRun(true);
        return liquibase;
    }
}

2 编写升级的xml文件如下：

master.xml

<?xml version="1.0" encoding="utf-8"?>
<databaseChangeLog
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">


</databaseChangeLog>

8 引入json库

<dependency>
   <groupId>com.fasterxml.jackson.core</groupId>
   <artifactId>jackson-databind</artifactId>
   <version>2.8.3</version>
</dependency>

至此，整个demo完成