SpringBoot3之Web编程

标签：Rest.拦截器.swagger.测试;

一、简介

基于web包的依赖，SpringBoot可以快速启动一个web容器，简化项目的开发；
在web开发中又涉及如下几个功能点：
拦截器：可以让接口被访问之前，将请求拦截到，通过对请求的识别和校验，判断请求是否允许通过；
页面交互：对于服务端的开发来说，需要具备简单的页面开发能力，解决部分场景的需求；
Swagger接口：通过简单的配置，快速生成接口的描述，并且提供对接口的测试能力；
Junit测试：通过编写代码的方式对接口进行测试，从而完成对接口的检查和验证，并且可以不入侵原代码结构；
二、工程搭建

1、工程结构


2、依赖管理

1. <dependency>
2.     <groupId>org.springframework.boot</groupId>
3.     <artifactId>spring-boot-starter-web</artifactId>
4.     <version>${spring-boot.version}</version>
5. </dependency>
7. <dependency>
8.     <groupId>org.springdoc</groupId>
9.     <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
10.     <version>${springdoc.version}</version>
11. </dependency>
13. <dependency>
14.     <groupId>org.springframework.boot</groupId>
15.     <artifactId>spring-boot-starter-thymeleaf</artifactId>
16.     <version>${spring-boot.version}</version>
17. </dependency>
19. <dependency>
20.     <groupId>org.springframework.boot</groupId>
21.     <artifactId>spring-boot-starter-test</artifactId>
22.     <version>${spring-boot.version}</version>
23.     <exclusions>
24.         <exclusion>
25.             <groupId>org.slf4j</groupId>
26.             <artifactId>slf4j-api</artifactId>
27.         </exclusion>
28.     </exclusions>
29. </dependency>
30. <dependency>
31.     <groupId>junit</groupId>
32.     <artifactId>junit</artifactId>
33.     <version>${junit.version}</version>
34. </dependency>

复制代码

三、Web开发

1、接口开发

编写四个简单常规的接口，从对资源操作的角度，也就是常说的：增Post、删Delete、改Put、查Get，并且使用了swagger注解，可以快速生成接口文档；

1. @RestController
2. @Tag(name = "Rest接口")
3. public class RestWeb {
5.     @Operation(summary = "Get接口")
6.     @GetMapping("rest/get/{id}")
7.     public String restGet(@PathVariable Integer id) {
8.         return "OK:"+id;
9.     }
11.     @Operation(summary = "Post接口")
12.     @PostMapping("/rest/post")
13.     public String restPost(@RequestBody ParamBO param){
14.         return "OK:"+param.getName();
15.     }
17.     @Operation(summary = "Put接口")
18.     @PutMapping("/rest/put")
19.     public String restPut(@RequestBody ParamBO param){
20.         return "OK:"+param.getId();
21.     }
23.     @Operation(summary = "Delete接口")
24.     @DeleteMapping("/rest/delete/{id}")
25.     public String restDelete(@PathVariable Integer id){
26.         return "OK:"+id;
27.     }
28. }

复制代码

2、页面交互

对于服务端开发来说，在部分场景下是需要进行简单的页面开发的，比如通过页面渲染再去生成文件，或者直接通过页面填充邮件内容等；
数据接口

1. @Controller
2. public class PageWeb {
4.     @RequestMapping("/page/view")
5.     public ModelAndView pageView (HttpServletRequest request){
6.         ModelAndView modelAndView = new ModelAndView() ;
7.         // 普通参数
8.         modelAndView.addObject("name", "cicada");
9.         modelAndView.addObject("time", "2023-07-12");
10.         // 对象模型
11.         modelAndView.addObject("page", new PageBO(7,"页面数据模型"));
12.         // List集合
13.         List<PageBO> pageList = new ArrayList<>() ;
14.         pageList.add(new PageBO(1,"第一页"));
15.         pageList.add(new PageBO(2,"第二页"));
16.         modelAndView.addObject("pageList", pageList);
17.         // Array数组
18.         PageBO[] pageArr = new PageBO[]{new PageBO(6,"第六页"),new PageBO(7,"第七页")} ;
19.         modelAndView.addObject("pageArr", pageArr);
20.         modelAndView.setViewName("/page-view");
21.         return modelAndView ;
22.     }
23. }

复制代码

页面解析：分别解析了普通参数，实体对象，集合容器，数组容器等几种数据模型；

1.     <hr/>
2.     <h5>普通参数解析</h5>
3.     姓名：
4.     时间：
5.     <hr/>
6.     <h5>对象模型解析</h5>
7.     整形：
8.     字符：
9.     <hr/>
10.     <h5>集合容器解析</h5>
11.     <table >
12.         <tr>
13.             <th>Key</th>
14.             <th>Value</th>
15.         </tr>
16.         <tr th:each="page:${pageList}">
17.             <td th:text="${page.getKey()}"></td>
18.             <td th:text="${page.getValue()}"></td>
19.         </tr>
20.     </table>
21.     <hr/>
22.     <h5>数组容器解析</h5>
23.     <table >
24.         <tr>
25.             <th>Key</th>
26.             <th>Value</th>
27.         </tr>
28.         <tr th:each="page:${pageArr}">
29.             <td th:text="${page.getKey()}"></td>
30.             <td th:text="${page.getValue()}"></td>
31.         </tr>
32.     </table>
33.     <hr/>

复制代码

效果图展示

四、拦截器

1、拦截器定义

通过实现HandlerInterceptor接口，完成对两个拦截器的自定义，请求在访问服务时，必须通过两个拦截器的校验；

1. /**
2. * 拦截器一
3. */
4. public class HeadInterceptor implements HandlerInterceptor {
5.     private static final Logger log  = LoggerFactory.getLogger(HeadInterceptor.class);
6.     @Override
7.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
8.                              Object handler) throws Exception {
9.         log.info("HeadInterceptor:preHandle");
10.         Iterator<String> headNames = request.getHeaderNames().asIterator();
11.         log.info("request-header");
12.         while (headNames.hasNext()){
13.             String headName = headNames.next();
14.             String headValue = request.getHeader(headName);
15.             System.out.println(headName+":"+headValue);
16.         }
17.         // 放开拦截
18.         return true;
19.     }
20.     @Override
21.     public void postHandle(HttpServletRequest request,HttpServletResponse response,
22.                            Object handler, ModelAndView modelAndView) throws Exception {
23.         log.info("HeadInterceptor:postHandle");
24.     }
25.     @Override
26.     public void afterCompletion(HttpServletRequest request,HttpServletResponse response,
27.                                 Object handler, Exception e) throws Exception {
28.         log.info("HeadInterceptor:afterCompletion");
29.     }
30. }
32. /**
33. * 拦截器二
34. */
35. public class BodyInterceptor implements HandlerInterceptor {
36.     private static final Logger log  = LoggerFactory.getLogger(BodyInterceptor.class);
37.     @Override
38.     public boolean preHandle(HttpServletRequest request,HttpServletResponse response,
39.                              Object handler) throws Exception {
40.         log.info("BodyInterceptor:preHandle");
41.         Iterator<String> paramNames = request.getParameterNames().asIterator();
42.         log.info("request-param");
43.         while (paramNames.hasNext()){
44.             String paramName = paramNames.next();
45.             String paramValue = request.getParameter(paramName);
46.             System.out.println(paramName+":"+paramValue);
47.         }
48.         // 放开拦截
49.         return true;
50.     }
51.     @Override
52.     public void postHandle(HttpServletRequest request,HttpServletResponse response,
53.                            Object handler, ModelAndView modelAndView) throws Exception {
54.         log.info("BodyInterceptor:postHandle");
55.     }
56.     @Override
57.     public void afterCompletion(HttpServletRequest request,HttpServletResponse response,
58.                                 Object handler, Exception e) throws Exception {
59.         log.info("BodyInterceptor:afterCompletion");
60.     }
61. }

复制代码

2、拦截器配置

自定义拦截器之后，还需要添加到web工程的配置文件中，可以通过实现WebMvcConfigurer接口，完成自定义的配置添加；

1. @Configuration
2. public class WebMvcConfig implements WebMvcConfigurer {
4.     /**
5.      * 添加自定义拦截器
6.      */
7.     @Override
8.     public void addInterceptors(InterceptorRegistry registry) {
9.         registry.addInterceptor(new HeadInterceptor()).addPathPatterns("/**");
10.         registry.addInterceptor(new BodyInterceptor()).addPathPatterns("/**");
11.     }
12. }

复制代码

五、测试工具

1、Swagger接口

添加上述的springdoc依赖之后，还可以在配置文件中简单定义一些信息，访问IP:端口/swagger-ui/index.html即可；

1. @Configuration
2. public class WebMvcConfig implements WebMvcConfigurer {
4.     /**
5.      * 接口文档配置
6.      */
7.     @Bean
8.     public OpenAPI openAPI() {
9.         return new OpenAPI()
10.                 .info(new Info().title("【boot-web】").description("Rest接口文档-2023-07-11")
11.                 .version("1.0.0"));
12.     }
13. }

复制代码

2、Junit测试

在个人的习惯上，Swagger接口文档更偏向在前后端对接的时候使用，而Junit单元测试更符合开发的时候使用，这里是对RestWeb中的接口进行测试；

1. @RunWith(SpringRunner.class)
2. @SpringBootTest
3. @AutoConfigureMockMvc
4. public class RestWebTest {
6.     @Autowired
7.     private MockMvc mockMvc;
9.     @Test
10.     public void testGet () throws Exception {
11.         // GET接口测试
12.         MvcResult mvcResult = mockMvc
13.                 .perform(MockMvcRequestBuilders.get("/rest/get/1"))
14.                 .andReturn();
15.         printMvcResult(mvcResult);
16.     }
18.     @Test
19.     public void testPost () throws Exception {
20.         // 参数模型
21.         JsonMapper jsonMapper = new JsonMapper();
22.         ParamBO param = new ParamBO(null,"单元测试",new Date()) ;
23.         String paramJson = jsonMapper.writeValueAsString(param) ;
24.         // Post接口测试
25.         MvcResult mvcResult = mockMvc.perform(MockMvcRequestBuilders.post("/rest/post")
26.                 .contentType(MediaType.APPLICATION_JSON)
27.                 .accept(MediaType.APPLICATION_JSON).content(paramJson)).andReturn();
28.         printMvcResult(mvcResult);
29.     }
31.     @Test
32.     public void testPut () throws Exception {
33.         // 参数模型
34.         JsonMapper jsonMapper = new JsonMapper();
35.         ParamBO param = new ParamBO(7,"Junit组件",new Date()) ;
36.         String paramJson = jsonMapper.writeValueAsString(param) ;
37.         // Put接口测试
38.         MvcResult mvcResult = mockMvc.perform(MockMvcRequestBuilders.put("/rest/put")
39.                 .contentType(MediaType.APPLICATION_JSON)
40.                 .accept(MediaType.APPLICATION_JSON).content(paramJson)).andReturn();
41.         printMvcResult(mvcResult);
42.     }
44.     @Test
45.     public void testDelete () throws Exception {
46.         // Delete接口测试
47.         MvcResult mvcResult = mockMvc
48.                 .perform(MockMvcRequestBuilders.delete("/rest/delete/2"))
49.                 .andReturn();
50.         printMvcResult(mvcResult);
51.     }
53.     /**
54.      * 打印【MvcResult】信息
55.      */
56.     private void printMvcResult (MvcResult mvcResult) throws Exception {
57.         System.out.println("请求-URI【"+mvcResult.getRequest().getRequestURI()+"】");
58.         System.out.println("响应-status【"+mvcResult.getResponse().getStatus()+"】");
59.         System.out.println("响应-content【"+mvcResult.getResponse().getContentAsString(StandardCharsets.UTF_8)+"】");
60.     }
61. }

复制代码

六、参考源码

1. 文档仓库：
2. https://gitee.com/cicadasmile/butte-java-note
4. 源码仓库：
5. https://gitee.com/cicadasmile/butte-spring-parent

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！