SpringBoot学习02——Swagger/UnitTest/传参方式/HandlerInterceptor

最新推荐文章于 2023-09-20 22:12:05 发布

bengbeng_biu

最新推荐文章于 2023-09-20 22:12:05 发布

阅读量548

点赞数

分类专栏： SpringBoot 文章标签： spring boot java

本文链接：https://blog.csdn.net/weixin_46718393/article/details/115748498

版权

SpringBoot 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

SpringBoot学习02——初识

一、Swagger

Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。

其实归根到底，使用Swagger，就是把相关的信息存储在它定义的描述文件里面（yml或json格式），再通过维护这个描述文件可以去更新接口文档，以及生成各端代码。而Springfox-swagger,则可以通过扫描代码去生成这个描述文件，连描述文件都不需要再去维护了。所有的信息，都在代码里面了。代码即接口文档，接口文档即代码。

依赖添加

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>javax.xml.bind</groupId>
            <artifactId>jaxb-api</artifactId>
            <version>2.3.0</version>
        </dependency>

SwaggerConfig

Swagger2配置类

/**
 * @Auther: 张淇囿
 * @Date: 2021/04/14/9:38
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot实战")
                .description("Spring Boot实战的RESTFul接口文档说明")
                .version("1.0")
                .build();
    }
}

如上所示，docket()方法创建Docket的Bean对象，apiInfo()则是创建ApiInfo的基本信息。

swagger-ui.html#

注解及说明

@Api: 用在类上，说明该类的主要作用。
@ApiOperation：用在方法上，给API增加方法说明。
@ApiImplicitParams : 用在方法上，包含一组参数说明。
@ApiImplicitParam：用来注解来给方法入参增加说明。
- 属性
  - paramType：查询参数类型
    - 取值
      - path：以地址的形式提交数据
      - query：直接跟参数完成自动映射赋值
      - body：以流的形式提交仅支持POST
      - header：参数在request headers里边提交
      - form：以form表单的形式提交仅支持POST
  - dataType：参数的数据类型只作为标志说明，并没有实际验证
    - 取值
      - Long
      - String
  - name：接受参数名
  - value：接收参数的意义描述
  - required：参数是否必填
    - 取值
      - true：必填
      - false：非必填
  - defaultValue：默认值
- @ApiResponses：用于表示一组响应
- @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
  - code：数字，例如400
  - message：信息，例如"请求参数没填好"
  - response：抛出异常的类
- @ApiModel：用在返回对象类上，描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）
- @ApiModelProperty：描述一个model的属性

二、UnitTest

Spring 框架提供了一个专门的测试模块（spring-test），用于应用程序的集成测试。在 Spring Boot 中，你可以通过spring-boot-starter-test启动器快速开启和使用它。

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

实例代码：

/**
 * @Auther: 张淇囿
 * @Date: 2021/04/14/11:43
 */
// 让 JUnit 运行 Spring 的测试环境， 获得 Spring 环境的上下文的支持
@RunWith(SpringRunner.class)
// 获取启动类，加载配置，确定装载 Spring 程序的装载方法，它回去寻找 主配置启动类（被 @SpringBootApplication 注解的）
@SpringBootTest
//spring的注解，能够自动配置MockMvc对象实例，用来在模拟测试环境中发送http请求。
@AutoConfigureMockMvc
public class HelloControllerTest {

    @Autowired
    private MockMvc mvc;

    @BeforeClass
    public static void beforeClass() {
        System.out.println("===before class===");
    }

    @Before
    public void setUp() throws Exception {
        System.out.println("===before method===");
    }

    @Test
    public void hello() throws Exception {
        MvcResult result = mvc.perform(get("/hello")
                .header("version","2")
                .param("name", "IMOOC")
                .contentType(MediaType.APPLICATION_JSON))
                .andExpect(content().string("Hello IMOOC")).andReturn();

        System.out.println("==="+result.getResponse().getContentAsString()+"===");
    }

    @After
    public void tearDown() throws Exception {
        System.out.println("===after method===");
    }

    @AfterClass
    public static void afterClass() {
        System.out.println("===after class===");
    }

}

JUnit中的注解

@BeforeClass：针对所有测试，只执行一次，且必须为static void
@Before：初始化方法，执行当前测试类的每个测试方法前执行。
@Test：测试方法，在这里可以测试期望异常和超时时间
@After：释放资源，执行当前测试类的每个测试方法后执行
@AfterClass：针对所有测试，只执行一次，且必须为static void
@Ignore：忽略的测试方法（只在测试类的时候生效，单独执行该测试方法无效）
@RunWith:可以更改测试运行器，缺省值 org.junit.runner.Runner

一个单元测试类执行顺序为

@BeforeClass –> @Before –> @Test –> @After –> @AfterClass

每一个测试方法的调用顺序为

@Before –> @Test –> @After

超时测试

如果一个测试用例比起指定的毫秒数花费了更多的时间，那么 Junit 将自动将它标记为失败。timeout 参数和 @Test注释一起使用。现在让我们看看活动中的 @test(timeout)。

@Test(timeout = 1000)
    public void testTimeout() throws InterruptedException {
        TimeUnit.SECONDS.sleep(2);
        System.out.println("Complete");
    }

上面测试会失败，在一秒后会抛出异常 org.junit.runners.model.TestTimedOutException: test timed out after 1000 milliseconds

三、传参方式

@Api
@RestController
public class ParamController {

    @ApiOperation(value = "无注解方式")
    @GetMapping("/noannotation")
    public User noAnnotation( User user) {
        return user;
    }

    @ApiOperation(value = "@RequestParam方式")
    @GetMapping("/requestparam")
    public User RequestParam(@RequestParam String name, @RequestParam int age) {
        User user = new User();
        user.setName(name);
        user.setAge(age);
        return user;
    }
    @ApiOperation(value = "@PathVariable方式")
    @GetMapping("/pathvariable/{name}/{age}")
    public User PathVariable(@PathVariable String name,@PathVariable int age) {
        User user = new User();
        user.setName(name);
        user.setAge(age);
        return user;
    }

    @ApiOperation(value = "@RequestBody方式")
    @PostMapping("/requestbody")
    public User RequestBody(@RequestBody @Valid User user) {
        return user;
    }
}

无注解方式

根据该方法的形参自动提供相应参数接受
@RequestParam方式

语法：@RequestParam(value=”参数名”,required=”true/false”,defaultValue=””)

value：参数名

required：是否包含该参数，默认为true，表示该请求路径中必须包含该参数，如果不包含就报错。

defaultValue：默认参数值，如果设置了该值，required=true将失效，自动为false,如果没有传该参数，就使用默认值
@PathVariable方式

映射URL绑定的占位符
带占位符的URL是 Spring3.0 新增的功能，URL中的 {xxx} 占位符可以通过 @PathVariable(“xxx”) 绑定到操作方法的入参中。
@RequestBody方式

@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)；GET方式无请求体，所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而是用POST方式进行提交。在后端的同一个接收方法里，@RequestBody与@RequestParam()可以同时使用，@RequestBody最多只能有一个，而@RequestParam()可以有多个。

四、HandlerInterceptor（拦截器）

HandlerInterceptor 的功能跟过滤器类似，但是提供更精细的的控制能力：在request被响应之前、request被响应之后、视图渲染之前以及request全部结束之后。我们不能通过拦截器修改request内容，但是可以通过抛出异常（或者返回false）来暂停request的执行。

boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception;

	void postHandle(
			HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
			throws Exception;

	void afterCompletion(
			HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
			throws Exception;

preHandle：在业务处理器处理请求之前被调用。预处理，可以进行编码、安全控制、权限校验等处理；
postHandle：在业务处理器处理请求执行完成后，生成视图之前执行。后处理（调用了Service并返回ModelAndView，但未进行页面渲染），有机会修改ModelAndView ；
afterCompletion：在DispatcherServlet完全处理完请求后被调用，可用于清理资源等。返回处理（已经渲染了页面）；

bengbeng_biu

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot学习02——Swagger/UnitTest/传参方式/HandlerInterceptor

SpringBoot学习02——初识一、Swagger依赖添加SwaggerConfigSwagger2配置类注解及说明二、UnitTestJUnit中的注解超时测试三、传参方式无注解方式`@RequestParam`方式`@PathVariable`方式`@RequestBody`方式四、HandlerInterceptor（拦截器）一、SwaggerSwagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger 的目标是对 REST
复制链接

扫一扫