5. controller层

import pers.beiluo.yunshangoffice.model.system.SysRole;import pers.beiluo.yunshangoffice.service.SysRoleService;import java.util.List;//@RestController：1.该类是控制器；2.方法返回值会被写进响应报文的报文体，而不是作为视图解析@RestController@RequestMapping("admin/system/sysRole")public class SysRoleController {@Autowiredprivate SysRoleService sysRoleService;@GetMapping("/getAll")public List<SysRole> getAllRole(){List<SysRole> list = sysRoleService.list();return list;}}

6. 定义统一返回结果对象

项目中会将响应封装成json返回，为了使得后端所有接口返回的内容有一个规范，就需要定义统一的返回结果格式，这个类定义在common-util模块下。

//返回结果自定义状态码枚举类型package pers.beiluo.yunshangoffice.result;import lombok.Getter;@Getterpublic enum ResultCodeEnum {SUCCESS(200,"成功"),FAIL(201, "失败"),;private Integer code;private String message;private ResultCodeEnum(Integer code,String message){this.code = code;this.message = message;}}
//定义类用于得到返回结果package pers.beiluo.yunshangoffice.common.result;import lombok.Data;/** * 结果格式为： *返回码 *返回信息 *返回数据 * @param  */@Datapublic class Result <T>{//返回码private Integer code;//返回消息private String message;//返回数据private T data;public Result(){}//构建返回结果public static<T> Result<T> build(T data,ResultCodeEnum resultCodeEnum){Result<T> TResult = new Result<>();if(data != null){TResult.setData(data);}TResult.setCode(resultCodeEnum.getCode());TResult.setMessage(resultCodeEnum.getMessage());return TResult;}//操作成功public static <T> Result<T> ok(){return build(null, ResultCodeEnum.SUCCESS);}public static <T> Result<T> ok(T data){return build(data,ResultCodeEnum.SUCCESS);}//操作失败public static <T> Result<T> fail(){return build(null,ResultCodeEnum.FAIL);}public static <T> Result<T> fail(T data){return build(data,ResultCodeEnum.FAIL);}}

定义了统一返回对象后，需要修改controller层，使得控制器返回的结果都是定义好的类型。

package pers.beiluo.yunshangoffice.controller;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;import pers.beiluo.yunshangoffice.common.result.Result;import pers.beiluo.yunshangoffice.model.system.SysRole;import pers.beiluo.yunshangoffice.service.SysRoleService;import java.util.List;//@RestController：1.该类是控制器；2.方法返回值会被写进响应报文的报文体，而不是作为视图解析@RestController@RequestMapping("admin/system/sysRole")public class SysRoleController {@Autowiredprivate SysRoleService sysRoleService;//@GetMapping("/getAll")//public List getAllRole(){//List list = sysRoleService.list();//System.out.println(list);//return list;//}public Result<List<SysRole>> getAllRole(){List<SysRole> list = sysRoleService.list();return Result.ok(list);}}

7. 整合knife4j

**注意：**版本过高的springboot和swagger无法兼容，导致程序会报错，写项目的目的是熟悉开发过程，加强对框架的使用，关注点并不在解决这个调试框架的不兼容问题上，所以最好的办法是先降低springboot的版本到2.3.x。这个问题可以完成项目后再研究。
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。它方便我们发送请求并对接口进行测试。下面将knife4j集成到service-util模块。以下内容都放在service-util模块中。

  1. 在service-util模块中引入依赖
<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId></dependency>
  1. 添加knife4j配置类
package pers.beiluo.yunshangoffice.common.config.knife4j;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.ParameterBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.schema.ModelRef;import springfox.documentation.service.ApiInfo;import springfox.documentation.service.Contact;import springfox.documentation.service.Parameter;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;import java.util.ArrayList;import java.util.List;/** * knife4j配置信息 */@Configuration@EnableSwagger2WebMvcpublic class Knife4jConfig {@Beanpublic Docket adminApiConfig(){List<Parameter> pars = new ArrayList<>();ParameterBuilder tokenPar = new ParameterBuilder();tokenPar.name("token").description("用户token").defaultValue("").modelRef(new ModelRef("string")).parameterType("header").required(false).build();pars.add(tokenPar.build());//添加head参数endDocket adminApi = new Docket(DocumentationType.SWAGGER_2).groupName("adminApi").apiInfo(adminApiInfo()).select()//只显示admin路径下的页面//注意这个basePackage要写成自己的包.apis(RequestHandlerSelectors.basePackage("com.atguigu")).paths(PathSelectors.regex("/admin/.*")).build().globalOperationParameters(pars);return adminApi;}private ApiInfo adminApiInfo(){return new ApiInfoBuilder().title("后台管理系统-API文档").description("本文档描述了后台管理系统微服务接口定义").version("1.0").contact(new Contact("atguigu", "http://atguigu.com", "atguigu@qq.com")).build();}}

  1. 在controller层添加注解
    • 在类上添加@Api注解，表示这是一个swagger资源，并且可以通过tags属性为这个类添加说明。
    • 在方法上添加@ApiOperation注解，通过value属性给接口命名。
  2. 访问localhost:8800/doc.html就能看到测试页面。