實戰專案-02(講師邏輯刪除以及統一結果返回配置Swagger...)
阿新 • • 發佈：2021-10-17
講師邏輯刪除功能的實現
1. 配置邏輯刪除外掛
新建config包,在其中新建Educonfig
@Configuration
@MapperScan("com.sli.eduservice.mapper")//將主啟動類上面的mapperscan轉移到配置檔案中
public class EduConfig {
/**
* 邏輯刪除外掛
*/
@Bean
public ISqlInjector sqlInjector(){
return new LogicSqlInjector();
}
}
2. 在實體類上面添加註解
@TableLogic @ApiModelProperty(value = "邏輯刪除 1（true）已刪除， 0（false）未刪除") private Boolean isDeleted;
3. EduTeacherController新增刪除方法
@ApiOperation(value = "邏輯刪除講師") //2. 講師的邏輯刪除(1. 需要配置邏輯刪除外掛,2. 在實體類中加入tablelogic的註解 3. 編寫方法) //delete提交瀏覽器無法進行測試,所以只能用swagger進行測試,需要整合swagger,進行測試(建立公共模組整合swagger便於所有的模組都可以使用) @DeleteMapping("{id}")//{id}的意思是需要通過路徑進行傳遞id eg:localhost:8001/edu/delete/1----->此處的1需要通過路徑傳遞 public R removeTeacher(@ApiParam(name = "id" , value = "講師Id" , required = true) @PathVariable String id){//此處是得到路徑中的id值,然後就可以用這個id操作 boolean flag = teacherService.removeById(id); if (flag){ return R.ok(); }else { return R.error(); } }
Swagger測試
引入了Swagger
Swagger
1.介紹
前後端分離開發模式中，api文件是最好的溝通方式。
Swagger 是一個規範和完整的框架，用於生成、描述、呼叫和視覺化 RESTful 風格的 Web 服務。
- 及時性 (介面變更後，能夠及時準確地通知相關前後端開發人員)
- 規範性 (並且保證介面的規範性，如介面的地址，請求方式，引數及響應格式和錯誤資訊)
- 一致性 (介面資訊一致，不會出現因開發人員拿到的文件版本不一致，而出現分歧)
- 可測性 (直接在介面文件上進行測試，以方便理解業務)
2.配置Swagger
1. 建立common模組
在guli-parent下面建立模組common
1. 引入相關的依賴
點選檢視程式碼
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>guli-parent</artifactId>
<groupId>com.sli</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>common</artifactId>
<packaging>pom</packaging>
<modules>
<module>servcie_base</module>
<module>common_utils</module>
</modules>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<scope>provided </scope>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<scope>provided </scope>
</dependency>
<!--lombok用來簡化實體類：需要安裝lombok外掛-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided </scope>
</dependency>
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<scope>provided </scope>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<scope>provided </scope>
</dependency>
<!-- redis -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- spring2.X整合redis所需common-pool2
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
<version>2.6.0</version>
</dependency>-->
</dependencies>
</project>
2. 在common下面建立子模組service_base
3. 在service_base中,建立swagger配置類
在包com.sli.servicebase.config下面建立類SwaggerConfig
點選檢視程式碼
package com.sli.servicebase;
import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* @author 1_f_
* @create 2021-10-16 15:09
*/
@Configuration
@EnableSwagger2//swagger註解
public class SwaggerConfig {
@Bean
public Docket webApiConfig(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.paths(Predicates.not(PathSelectors.regex("/admin/.*")))
.paths(Predicates.not(PathSelectors.regex("/error.*")))
.build();
}
private ApiInfo webApiInfo(){
return new ApiInfoBuilder()
.title("網站-課程中心API文件")
.description("本文件描述了課程中心微服務介面定義")
.version("1.0")
.contact(new Contact("sli", "https://www.cnblogs.com/sli1f/",
"[email protected]"))
.build();
}
}
3. 在模組service中引入service-base
<dependency>
<groupId>com.sli</groupId>
<artifactId>servcie_base</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
因為在不同的工程中,spring的bean倉庫也不再一起,所以需要在service_edu啟動類上面添加註解,進行測試
@ComponentScan(basePackages = "com.sli")//包掃描規則,目的是掃描到common/service_base/中的swaggerconfig上面的configuration註解
測試訪問: http://localhost:8001/swagger-ui.html
4. 定義介面的引數說明
定義在類上面:@Api
定義在方法上面:@ApiOperation
定義在引數上:@ApiParam
eg:
@ApiOperation(value = "邏輯刪除講師")
//2. 講師的邏輯刪除(1. 需要配置邏輯刪除外掛,2. 在實體類中加入tablelogic的註解 3. 編寫方法)
//delete提交瀏覽器無法進行測試,所以只能用swagger進行測試,需要整合swagger,進行測試(建立公共模組整合swagger便於所有的模組都可以使用)
@DeleteMapping("{id}")//{id}的意思是需要通過路徑進行傳遞id eg:localhost:8001/edu/delete/1----->此處的1需要通過路徑傳遞
public R removeTeacher(@ApiParam(name = "id" , value = "講師Id" , required = true) @PathVariable String id){//此處是得到路徑中的id值,然後就可以用這個id操作
boolean flag = teacherService.removeById(id);
if (flag){
return R.ok();
}else {
return R.error();
}
}
統一返回資料格式
專案中我們會將響應封裝成json返回，一般我們會將所有介面的資料格式統一， 使前端(iOS Android,Web)對資料的操作更一致、輕鬆。
一般情況下，統一返回資料格式沒有固定的格式，只要能描述清楚返回的資料狀態以及要返回的具體資料就可以。但是一般會包含狀態碼、返回訊息、資料這幾部分內容
例如，我們的系統要求返回的基本資料格式如下：
{
"success": true,
"code": 20000,
"message": "成功",
"data": {
"items": [
{
"id": "1",
"name": "xxx",
"intro": "畢業於師範大學數學系，熱愛教育事業，執教數學思維6年有餘"
}
]
}
}
會要求我們返回的資料上面加上來表示成功或者失敗
"success": true,
"code": 20000,
"message": "成功",
因此我們定義統一的結果
{
"success": 布林, //響應是否成功
"code": 數字, //響應碼
"message": 字串, //返回訊息
"data": HashMap //返回資料，放在鍵值對中
}
建立統一結果返回類
1. 在common模組下面建立子模組common_utils
並建立com.sli.commonutils
建立返回碼介面ResultCode
package com.sli.commonutils;
/**
* @author 1_f_
* @create 2021-10-16 15:41
*/
public interface ResultCode {
//操作成功
public static Integer SUCCESS = 20000;
//操作失敗
public static Integer ERROR = 20001;
}
建立返回結果類R
package com.sli.commonutils;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.util.HashMap;
import java.util.Map;
/**
* @author 1_f_
* @create 2021-10-16 15:44
*/
@Data
//統一返回結果的類
public class R {
@ApiModelProperty(value = "是否成功")
private Boolean success;
@ApiModelProperty(value = "返回碼")
private Integer code;
@ApiModelProperty(value = "返回訊息")
private String message;
@ApiModelProperty(value = "返回資料")
private Map<String , Object> data = new HashMap<String , Object>();
//將構造方法私有
private R(){}
//成功靜態方法
public static R ok(){
R r = new R();
r.setSuccess(true);
r.setCode(ResultCode.SUCCESS);
r.setMessage("成功");
return r;
}
//失敗靜態方法
public static R error(){
R r = new R();
r.setSuccess(false);
r.setCode(ResultCode.ERROR);
r.setMessage("失敗");
return r;
}
//this就是當前類的物件,這樣做可以達到鏈式程式設計的效果
public R success(Boolean success){
this.setSuccess(success);
return this;
}
public R message(String message){
this.setMessage(message);
return this;
}
public R code(Integer code){
this.setCode(code);
return this;
}
public R data(String key, Object value){
this.data.put(key, value);
return this;
}
public R data(Map<String, Object> map){
this.setData(map);
return this;
}
}
統一返回結果使用
1. 在service中新增依賴
<dependency>
<groupId>com.sli</groupId>
<artifactId>commom_utils</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
修改controller的返回結果(將返回全部改為R型別)
eg:
@ApiOperation(value = "所有講師列表")
//1. 查詢是講師表中的所有資料
//rest風格
@GetMapping("/findAll")
public R findAllTeacher(){
//呼叫service中的方法實現查詢的所有操作
List<EduTeacher> list = teacherService.list(null);
return R.ok().data("items",list);
}
@ApiOperation(value = "邏輯刪除講師")
//2. 講師的邏輯刪除(1. 需要配置邏輯刪除外掛,2. 在實體類中加入tablelogic的註解 3. 編寫方法)
//delete提交瀏覽器無法進行測試,所以只能用swagger進行測試,需要整合swagger,進行測試(建立公共模組整合swagger便於所有的模組都可以使用)
@DeleteMapping("{id}")//{id}的意思是需要通過路徑進行傳遞id eg:localhost:8001/edu/delete/1----->此處的1需要通過路徑傳遞
public R removeTeacher(@ApiParam(name = "id" , value = "講師Id" , required = true) @PathVariable String id){//此處是得到路徑中的id值,然後就可以用這個id操作
boolean flag = teacherService.removeById(id);
if (flag){
return R.ok();
}else {
return R.error();
}
}