（一） spring boot 项目初始化 + 配置swagger页面，你真的会了吗？

小牛马程序员 2022-07-21

1445

1 SpringBoot是什么

Spring Boot 是由 Pivotal 团队提供的全新框架，其设计目的是用来简化新 Spring 应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。通过这种方式，Spring Boot 致力于在蓬勃发展的快速应用开发领域 (rapid application development) 成为领导者。

2 为什么要使用SpringBoot

在使用 spring 的框架时，避免不了各种繁琐的 xml 的配置。随着 spring 的迭代更新，更多的是约定大于配置，所以我们也就可以使用 springboot 来将这些进行整合，统一之后我们就可以使用 springboot 框架来进行开发。

这样所带来的好处：配置方便，开发速度快是 springboot 框架最大的特点。

下面首先简单介绍搭建一下 springboot 项目。

3 创建项目

为了方便，我们在 start.spring.io 网站进行 springboot 项目的创建：

创建好项目之后下载，通过idea打开，找到DemoApplication运行即可使用

4 配置接口

4.1 添加项目依赖

        <!--支持web的模块-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

4.2 创建controller类，添加接口

package com.banana.demo.controller;


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


@RestController
public class HelloWorldController {
    @GetMapping("/hello")
    public String index() {
        return "Hello World";
    }
}

4.3 运行访问

此时项目以经配置好接口，我们已经可以访问接口，通过DemoApplication启动项目，访问接口
localhost:8080/hello

5 配置测试类

5.1 添加依赖

        <!--单元测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>

5.2 添加测试类

在test包下的com.banana.demo包中创建HelloTests类，类中添加了对于之前写的接口的测试，用来测试接口是否正确。

package com.banana.demo;


import com.banana.demo.controller.HelloWorldController;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;


import static org.hamcrest.Matchers.equalTo;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;


@RunWith(SpringRunner.class)
@SpringBootTest
public class HelloTests {
    private MockMvc mvc;
    @Before
    public void setUp() throws Exception{
        mvc = MockMvcBuilders.standaloneSetup(new HelloWorldController()).build();
    }
    @Test
    public void getHello() throws Exception{
        mvc.perform(MockMvcRequestBuilders.get("/hello").accept(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk())
                .andExpect(content().string(equalTo("Hello World")));
    }
}

5.3 执行测试类

点击绿色开始箭头执行测试类

在控制台我们能看到测试类执行的结果

6 配置swagger页面

6.1 添加依赖

        <!--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>

6.2 添加SwaggerConfig类

在com.banana.demo.config包下添加swagger的配置类SwaggerConfig

package com.banana.demo.config;


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


@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

6.3 访问swagger-ui页面

至此以经配置完毕，我们可以访问swagger页面了
localhost:8080/swagger-ui.html

swagger spring spring框架初始化 springfox

文章转载自小牛马程序员，如果涉嫌侵权，请发送邮件至：contact@modb.pro进行举报，并提供相关证据，一经查实，墨天轮将立刻删除相关内容。