From e8491b7dd537d3ef1eb09bf65b0cb6835d39cdd5 Mon Sep 17 00:00:00 2001 From: solo-hx <6gEemAZ> Date: Thu, 5 Sep 2019 17:49:20 +0800 Subject: [PATCH] =?UTF-8?q?dev=E5=B7=A5=E5=85=B7=E7=B1=BB=E6=9B=B4?= =?UTF-8?q?=E6=96=B0=EF=BC=8Cswagger=E5=8C=85pom.xml=E5=BC=95=E5=85=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ruoyi-common/pom.xml | 26 +++ .../com/ruoyi/common/core/domain/Request.java | 26 +++ .../com/ruoyi/common/core/domain/Result.java | 73 ++++++++ .../common/core/domain/ServiceResult.java | 163 ++++++++++++++++++ .../com/ruoyi/common/core/page/PageHead.java | 34 ++++ .../ruoyi/common/core/page/PageResult.java | 26 +++ 6 files changed, 348 insertions(+) create mode 100644 ruoyi-common/src/main/java/com/ruoyi/common/core/domain/Request.java create mode 100644 ruoyi-common/src/main/java/com/ruoyi/common/core/domain/Result.java create mode 100644 ruoyi-common/src/main/java/com/ruoyi/common/core/domain/ServiceResult.java create mode 100644 ruoyi-common/src/main/java/com/ruoyi/common/core/page/PageHead.java create mode 100644 ruoyi-common/src/main/java/com/ruoyi/common/core/page/PageResult.java diff --git a/ruoyi-common/pom.xml b/ruoyi-common/pom.xml index 13cf7b8a3..3ce9da627 100644 --- a/ruoyi-common/pom.xml +++ b/ruoyi-common/pom.xml @@ -113,6 +113,32 @@ 1.16.18 + + + + + io.springfox + springfox-swagger2 + + + + + io.swagger + swagger-annotations + 1.5.21 + + + + io.swagger + swagger-models + 1.5.21 + + + io.springfox springfox-swagger-ui diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/Request.java b/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/Request.java new file mode 100644 index 000000000..cb731fa3b --- /dev/null +++ b/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/Request.java @@ -0,0 +1,26 @@ +package com.ruoyi.common.core.domain; + +import com.ruoyi.common.base.BaseBean; +import io.swagger.annotations.ApiModelProperty; +import lombok.*; + + +/** + * 协议请求 + * + * @author solo + * @date 2019/09/05. + */ +@NoArgsConstructor +@AllArgsConstructor +@Builder +@Getter +@Setter +public class Request extends BaseBean { + + @ApiModelProperty(value = "序列码", example = "a006910b-5274-4514-89c6-5ca08aa19e60") + private String serialNum; + + @ApiModelProperty(value = "请求内容") + private T data; +} diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/Result.java b/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/Result.java new file mode 100644 index 000000000..18843d33d --- /dev/null +++ b/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/Result.java @@ -0,0 +1,73 @@ +package com.ruoyi.common.core.domain; + +import com.ruoyi.common.base.BaseBean; +import com.ruoyi.common.result.ErrorCodes; +import io.swagger.annotations.ApiModelProperty; +import lombok.*; + +/** + * @author solo + * @date 2019/09/05 + */ +@NoArgsConstructor +@AllArgsConstructor +@Builder +@Getter +@Setter +public class Result extends BaseBean { + + @ApiModelProperty(value = "响应提示码", example = "1000") + private ErrorCodes errorCode; + + @ApiModelProperty(value = "响应内容") + private Object data; + + /** + * 操作成功 + * + * @return + */ + public static Result ok() { + return Result.builder().errorCode(ErrorCodes.SUCCESS).build(); + } + + /** + * 操作成功 + * + * @param data 返回值 + * @return + */ + public static Result ok(Object data) { + return Result.builder().data(data).errorCode(ErrorCodes.SUCCESS).build(); + } + + + /** + * 操作失败 + * + * @param errorCode 失败明细 + * @return + */ + public static Result fail(ErrorCodes errorCode) { + return Result.builder().data(errorCode.getMessage()).errorCode(errorCode).build(); + } + + /** + * 操作失败 + * + * @param data 失败明细 + * @return + */ + public static Result fail(Object data) { + return Result.builder().data(data).errorCode(ErrorCodes.FAIL).build(); + } + + /** + * 是否操作成功 + * + * @return + */ + public boolean isSuccess() { + return errorCode.getCode() == 0; + } +} diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/ServiceResult.java b/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/ServiceResult.java new file mode 100644 index 000000000..7bb028e37 --- /dev/null +++ b/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/ServiceResult.java @@ -0,0 +1,163 @@ +package com.ruoyi.common.core.domain; + +import com.ruoyi.common.base.BaseBean; +import com.ruoyi.common.result.ErrorCodes; +import io.swagger.annotations.ApiModelProperty; +import lombok.*; + + +/** + * Service返回 + * + * @author solo + * @date 2019/09/05. + */ +@NoArgsConstructor +@AllArgsConstructor +@Builder +@Getter +@Setter +public class ServiceResult extends BaseBean { + @ApiModelProperty(value = "序列码", example = "a006910b-5274-4514-89c6-5ca08aa19e60") + private String serialNum; + + @ApiModelProperty(value = "错误码，0 表示成功", example = "0") + private Integer errorCode; + + @ApiModelProperty(value = "提示语", example = "操作成功") + private String message; + + @ApiModelProperty(value = "记录总数", example = "12") + private Long total; + + @ApiModelProperty(value = "响应内容") + private T rows; + + /** + * 操作成功 + */ + public static ServiceResult ok() { + return ok(ErrorCodes.SUCCESS); + } + + /** + * 操作成功 + */ + public static ServiceResult ok(Object data) { + return ServiceResult.builder() + .errorCode(ErrorCodes.SUCCESS.getCode()) + .message(ErrorCodes.SUCCESS.getMessage()) + .rows(data) + .build(); + } + + + /** + * 操作成功 + */ + public static ServiceResult ok(ErrorCodes errorCode) { + return ServiceResult.builder() + .errorCode(ErrorCodes.SUCCESS.getCode()) + .message(errorCode.getMessage()) + .build(); + } + + /** + * 操作成功 可自定义成功响应描述 + * + * @param data + * @param message + * @return + */ + public static ServiceResult ok(Object data, String message, Long count) { + return ServiceResult.builder() + .errorCode(ErrorCodes.SUCCESS.getCode()) + .message(message) + .rows(data) + .total(count) + .build(); + } + + /** + * 操作成功 可自定义成功响应描述 + * + * @param data + * @param message + * @return + */ + public static ServiceResult ok(Object data, String message) { + return ServiceResult.builder() + .errorCode(ErrorCodes.SUCCESS.getCode()) + .message(message) + .rows(data) + .build(); + } + + /** + * 操作成功 可自定义成功响应描述 + * + * @param data + * @param count + * @return + */ + public static ServiceResult ok(Object data, Long count) { + return ServiceResult.builder() + .errorCode(ErrorCodes.SUCCESS.getCode()) + .message(ErrorCodes.SUCCESS.getMessage()) + .total(count) + .rows(data) + .build(); + } + + /** + * 返回失败原因信息 + */ + public static ServiceResult fail(ErrorCodes errorCode) { + return ServiceResult.builder() + .errorCode(errorCode.getCode()) + .message(errorCode.getMessage()) + .build(); + } + + /** + * 返回失败原因信息 + */ + public static ServiceResult fail(ErrorCodes errorCode,Object data) { + return ServiceResult.builder() + .errorCode(errorCode.getCode()) + .message(errorCode.getMessage()) + .rows(data) + .build(); + } + + /** + * 返回失败原因信息 + */ + public static ServiceResult fail(String message,Object data) { + return ServiceResult.builder() + .errorCode(ErrorCodes.FAIL.getCode()) + .message(message) + .rows(data) + .build(); + } + + /** + * 返回失败原因信息 + */ + public static ServiceResult fail(String message) { + return ServiceResult.builder() + .errorCode(ErrorCodes.FAIL.getCode()) + .message(message) + .build(); + } + + /** + * 操作失败，默认错误 + */ + public static ServiceResult fail() { + return ServiceResult.builder() + .errorCode(ErrorCodes.FAIL.getCode()) + .message(ErrorCodes.FAIL.getMessage()) + .build(); + } +} diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/core/page/PageHead.java b/ruoyi-common/src/main/java/com/ruoyi/common/core/page/PageHead.java new file mode 100644 index 000000000..37a8e9deb --- /dev/null +++ b/ruoyi-common/src/main/java/com/ruoyi/common/core/page/PageHead.java @@ -0,0 +1,34 @@ +package com.ruoyi.common.core.page; + +import com.ruoyi.common.base.BaseBean; +import io.swagger.annotations.ApiModelProperty; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +/** + * PageHead + * + * @author solo + * @date 2019-09-05 + */ +@NoArgsConstructor +@AllArgsConstructor +@Getter +@Setter +public class PageHead extends BaseBean { + + @ApiModelProperty(value = "排序字段", example = "id") + private String sort; + + @ApiModelProperty(value = "排序方式", example = "desc") + private String order; + + @ApiModelProperty(value = "当前页数", example = "1") + private Integer page = 1; + + @ApiModelProperty(value = "每页多少数据", example = "10") + private Integer rows = 10; + +} diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/core/page/PageResult.java b/ruoyi-common/src/main/java/com/ruoyi/common/core/page/PageResult.java new file mode 100644 index 000000000..48fbdc138 --- /dev/null +++ b/ruoyi-common/src/main/java/com/ruoyi/common/core/page/PageResult.java @@ -0,0 +1,26 @@ +package com.ruoyi.common.core.page; + +import com.ruoyi.common.base.BaseBean; +import io.swagger.annotations.ApiModelProperty; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +/** + * PageResult + * @author solo + * @date 2019-09-05 + */ +@NoArgsConstructor +@AllArgsConstructor +@Getter +@Setter +public class PageResult extends BaseBean { + + @ApiModelProperty(value = "总页数", example = "12") + private Long totalCount; + + @ApiModelProperty(value = "对象") + private T body; +}