Spring-Custom之spring-custom-web

Bertha 。 2021-11-05 08:32 365阅读 0赞

Spring-Custom之spring-custom-web

  Spring-Custom是基于springboot开发的一些组件，自定义的一些规则规范开发过程.。spring-custom-web主要是对VO、Controller（RestController）做的一些封装。

版本说明

基于springboot 2.1.4.RELEASE(这部分影响不大)

  1. <parent>
  2.         <groupId>org.springframework.boot</groupId>
  3.         <artifactId>spring-boot-starter-parent</artifactId>
  4.         <version>2.1.4.RELEASE</version>
  5.         <relativePath/> <!-- lookup parent from repository -->
  6.     </parent>

具体代码可以查看
https://gitee.com/cjx913/spring-custom-web.git

配置文件的配置项

  1. spring:
  2.   custom:
  3.     web:
  4.     #返回的数据带有msg属性，默认是msg
  5.       message: message
  6.      #返回的数据带有code属性，默认是code
  7.       code: code
  8.       #表示路由，主要是对view的路径解析
  9.       router:
  10.         views:
  11.           login: login #login.html对应的url是login
  12.           register: register
  13.         children:
  14.         - path: manager
  15.           children:
  16.             - path: user
  17.               views:
  18.                 add: user_add,userAdd,user.html  # manager/user/add.html对应的url是/user_add和/userAdd和/user.html
  19.                 delete: user_delete
  20.             - path: order
  21.               views:
  22.                 add: order_add
  23.                 delete: order_delete

是入口类带上@EnableCustomWeb注解开启spring-custom-web功能

  1. @SpringBootApplication
  2. @RestController
  3. @EnableCustomWeb
  4. public class ResultTest { 
  5.     @Autowired
  6.     private ResultBuilder resultBuilder;
  8.     public static void main(String[] args) { 
  9.         SpringApplication.run(ResultTest.class, args);
  10.     }
  12.     @GetMapping("/test")
  13.     public ResultEntity test(HttpSession session) { 
  14.         Result result = resultBuilder.build();
  15.         result.addHeaders("header", "asdsadsda").addHeaders("header", "assafasggq12412")
  16.                 .setHeaders("header1", "asasdsadsad").setHeaders("header1", "a124123sasdsadsad")
  17.                 .addHeaders("sessionid", session.getId())
  18.                 .putBody("key", "asdasf")
  19.                 .putBody("name", "nasd");
  20.         return result.resultEntity(StatusCode.SELECT_SUCCESS, "saagasdasd", HttpStatus.OK);
  21.     }
  23.     @PostMapping("/user")
  24.     public ResultEntity user(@RequestBody UserBaseQueryVO userBaseQueryVO) { 
  25.         Result result = resultBuilder.build();
  26.         User user = new User();
  27.         user.setUsername("cjx913");
  28.         user.setPassword("cjx913");
  29.         User entity = userBaseQueryVO.getEntity();
  30.         result.putBody("user", entity);
  31.         return result.resultEntity();
  32.     }
  33. }

ResultEntity
public class ResultEntity extends ResponseEntity {…}
Result是Map,做了一些封装

  1. public class Result extends HashMap <String, Object> { 
  2.     protected String DEFAULT_CODE = "code";
  3.     protected String DEFAULT_MSG = "msg";
  5.     Result() { 
  7.     }
  9.     private MultiValueMap <String, String> headers = new HttpHeaders();
  11.     public ResultEntity resultEntity() { 
  12.         return resultEntity(HttpStatus.OK);
  13.     }
  15.     public ResultEntity resultEntityInternalServerError() { 
  16.         return resultEntity(HttpStatus.INTERNAL_SERVER_ERROR);
  17.     }
  19.     public ResultEntity resultEntity(HttpStatus status) { 
  20.         return resultEntity(null, null, status);
  21.     }
  23.     public ResultEntity resultEntity(Integer code, String msg) { 
  24.         return resultEntity(code, msg, HttpStatus.OK);
  25.     }
  27.     public ResultEntity resultEntityInternalServerError(Integer code, String msg) { 
  28.         return resultEntity(code, msg, HttpStatus.INTERNAL_SERVER_ERROR);
  29.     }
  31.     public ResultEntity resultEntity(Integer code, String msg, HttpStatus status) { 
  32.         if (status == null) { 
  33.             throw new ResponseException("HttpStatus can not be null");
  34.         }
  35.         if (msg != null) { 
  36.             this.putBody(DEFAULT_MSG, msg);
  37.         }
  38.         if (code != null) { 
  39.             this.putBody(DEFAULT_CODE, code);
  40.         }
  41.         if (headers == null || headers.isEmpty()) { 
  42.             return new ResultEntity(this, status);
  43.         } else { 
  44.             return new ResultEntity(this, headers, status);
  45.         }
  46.     }
  48.     public Result setCode(Integer code) { 
  49.         putBody(DEFAULT_CODE, code);
  50.         return this;
  51.     }
  53.     public Result setMsg(String msg) { 
  54.         putBody(DEFAULT_MSG, msg);
  55.         return this;
  56.     }
  58.     public Result putBody(String key, Object value) { 
  59.         this.put(key, value);
  60.         return this;
  61.     }
  63.     public Result removeBody(String key) { 
  64.         this.remove(key);
  65.         return this;
  66.     }
  68.     public Result addHeaders(String key, String value) { 
  69.         this.headers.add(key, value);
  70.         return this;
  71.     }
  73.     public Result setHeaders(String key, String value) { 
  74.         this.headers.set(key, value);
  75.         return this;
  76.     }
  78.     public Result removeHeaders(String key) { 
  79.         this.headers.remove(key);
  80.         return this;
  81.     }
  83.     public MultiValueMap <String, String> getHeaders() { 
  84.         return headers;
  85.     }
  87.     public Result setHeaders(MultiValueMap <String, String> headers) { 
  88.         this.headers = headers;
  89.         return this;
  90.     }
  92.     public Result addHeaders(MultiValueMap <String, String> headers) { 
  93.         this.headers.addAll(headers);
  94.         return this;
  95.     }
  97.     public String getDefaultCode() { 
  98.         return DEFAULT_CODE;
  99.     }
  101.     public void setDefaultCode(String defaultCode) { 
  102.         Integer code = (Integer) this.get(DEFAULT_CODE);
  103.         if (code != null) { 
  104.             this.removeBody(DEFAULT_CODE);
  105.             DEFAULT_CODE = defaultCode;
  106.             this.setCode(code);
  107.         } else { 
  108.             DEFAULT_CODE = defaultCode;
  109.         }
  110.     }
  112.     public String getDefaultMsg() { 
  113.         return DEFAULT_MSG;
  114.     }
  116.     public void setDefaultMsg(String defaultMsg) { 
  117.         String msg = (String) this.get(DEFAULT_MSG);
  118.         if (msg != null) { 
  119.             this.removeBody(DEFAULT_MSG);
  120.             DEFAULT_MSG = defaultMsg;
  121.             this.setMsg(msg);
  122.         } else { 
  123.             DEFAULT_MSG = defaultMsg;
  124.         }
  125.     }
  126. }

自定义了一些状态码StatusCode

  1. package cn.cjx913.spring_custom.web;
  3. /** * 操作状态码 * @author cjx913 * @version 1.0 * @since 2.1.2.RELEASE */
  4. public class StatusCode { 
  5.     /** * 查询成功 */
  6.     public static final Integer SELECT_SUCCESS = 101;
  7.     /** * 查询成功，但无数据 */
  8.     public static final Integer SELECT_SUCCESS_NO_DATA = 102;
  9.     /** * 查询失败 */
  10.     public static final Integer SELECT_FAIL = 103;
  11.     /** * 插入成功 */
  12.     public static final Integer INSERT_SUCCESS = 104;
  13.     /** * 插入失败 */
  14.     public static final Integer INSERT_FAIL = 105;
  15.     /** * 更新成功 */
  16.     public static final Integer UPDATE_SUCCESS = 106;
  17.     /** * 更新失败 */
  18.     public static final Integer UPDATE_FAIL = 107;
  19.     /** * 删除成功 */
  20.     public static final Integer DELETE_SUCCESS = 108;
  21.     /** * 删除失败 */
  22.     public static final Integer DELETE_FAIL = 109;
  25.     /** * 登陆成功 */
  26.     public static final Integer LOGIN_SUCCESS = 210;
  27.     /** * 登陆失败 */
  28.     public static final Integer LOGIN_FAIL = 211;
  29.     /** * 登陆失败,用户不存在 */
  30.     public static final Integer LOGIN_FAIL_UNREGISTER = 212;
  31.     /** * 登陆失败,无效登录凭证 */
  32.     public static final Integer LOGIN_FAIL_INVALID_CERTIFICATE = 213;
  33.     /** * 登陆失败,未知登录类型 */
  34.     public static final Integer LOGIN_FAIL_UNKONWN_LOGIN_TYPE = 214;
  35.     /** * 注册成功 */
  36.     public static final Integer REFISTER_SUCCESS = 220;
  37.     /** * 注册失败 */
  38.     public static final Integer REFISTER_FAIL = 221;
  39.     /** * 注册失败，用户已存在 */
  40.     public static final Integer REFISTER_FAIL_EXISTED_USER = 222;
  41.     /** * 注册失败，保存用户数据错误 */
  42.     public static final Integer REFISTER_FAIL_ERROR_SAVE_USER_DATA = 223;
  43.     /** * 注册失败,未知注册类型 */
  44.     public static final Integer REGISTER_FAIL_UNKONWN_REGISTER_TYPE = 224;
  46.     /** * 有效的session */
  47.     public static final Integer SESSION_VALID = 301;
  48.     /** * 无效的session */
  49.     public static final Integer SESSION_INVALID = 302;
  50.     /** * 有效的token */
  51.     public static final Integer TOKEN_VALID = 311;
  52.     /** * 无效的token */
  53.     public static final Integer TOKEN_INVALID = 312;
  54.     /** * 有效的验证码 */
  55.     public static final Integer VERIFICATION_CODE_VALID = 321;
  56.     /** * 无效的验证码 */
  57.     public static final Integer VERIFICATION_CODE_INVALID = 322;
  59.     /** * 未知错误 */
  60.     public static final Integer ERROR_UNKONWN = 900;
  61.     /** * 请求错误 */
  62.     public static final Integer ERROR_REQUSET = 910;
  63.     /** * 请求参数错误 */
  64.     public static final Integer ERROR_REQUSET_PARAMETER = 911;
  65.     /** * 响应错误 */
  66.     public static final Integer ERROR_RESPONSE = 920;
  68.     /** * 文件上传错误 */
  69.     public static final Integer ERROR_FILR_UPLOAD = 970;
  70.     /** * 文件下载错误 */
  71.     public static final Integer ERROR_FILR_DOWNLOAD = 980;
  72.     /** * 全局异常 */
  73.     public static final Integer ERROR_GLOBAL_EXCEPTIONS = 999;
  74. }

使用ResultBuilder来创建Result,使用@Autowrite注入的，能够使它跟配置文件的code，message一致

  1. @Autowired
  2.     private ResultBuilder resultBuilder;
  4.     ......
  6.     Result result = resultBuilder.build();

Result提供转换成ResultEntity的方法

  1. public ResultEntity resultEntity() { 
  2.         return resultEntity(HttpStatus.OK);
  3.     }
  5.     public ResultEntity resultEntityInternalServerError() { 
  6.         return resultEntity(HttpStatus.INTERNAL_SERVER_ERROR);
  7.     }
  9.     public ResultEntity resultEntity(HttpStatus status) { 
  10.         return resultEntity(null, null, status);
  11.     }
  13.     public ResultEntity resultEntity(Integer code, String msg) { 
  14.         return resultEntity(code, msg, HttpStatus.OK);
  15.     }
  17.     public ResultEntity resultEntityInternalServerError(Integer code, String msg) { 
  18.         return resultEntity(code, msg, HttpStatus.INTERNAL_SERVER_ERROR);
  19.     }
  21.     public ResultEntity resultEntity(Integer code, String msg, HttpStatus status) { 
  22.         if (status == null) { 
  23.             throw new ResponseException("HttpStatus can not be null");
  24.         }
  25.         if (msg != null) { 
  26.             this.putBody(DEFAULT_MSG, msg);
  27.         }
  28.         if (code != null) { 
  29.             this.putBody(DEFAULT_CODE, code);
  30.         }
  31.         if (headers == null || headers.isEmpty()) { 
  32.             return new ResultEntity(this, status);
  33.         } else { 
  34.             return new ResultEntity(this, headers, status);
  35.         }
  36.     }

还有对查询和结果做了一些规定

  1. package cn.cjx913.spring_custom.web.entity;
  3. import lombok.Getter;
  4. import lombok.Setter;
  6. import java.io.Serializable;
  7. import java.util.HashMap;
  8. import java.util.Map;
  10. @Setter
  11. @Getter
  12. /** * 查询参数封装 */
  13. public class BaseQueryVO<T>  implements Serializable { 
  16.     protected T entity;
  18.     /** * 数据有效性 */
  19.     protected Boolean available;
  21.     /** * 搜索文本 */
  22.     protected String searchText;
  23.     /** * 排序 */
  24.     protected String sortName;
  25.     /** * 排序 */
  26.     protected String sortOrder = "asc";
  28.     //分页
  29.     /** * 分页查询的页码 */
  30.     protected Integer pageNumber = 1;
  31.     /** * 分页查询的每頁的数据 */
  32.     protected Integer pageSize = 15;
  34.     /** * 分页查询的每頁的数据 */
  35.     protected Integer limit = 15;
  36.     /** * 分页查询的起始号 */
  37.     protected Integer offset = 0;
  39.     protected Map <String, Object> parameters = new HashMap <>();
  41.     public BaseQueryVO() { 
  43.     }
  45.     public BaseQueryVO(T entity) { 
  46.         this.entity = entity;
  47.     }
  48. }
  50. package cn.cjx913.spring_custom.web.entity;
  52. import lombok.Getter;
  53. import lombok.Setter;
  54. import org.springframework.util.CollectionUtils;
  56. import java.io.Serializable;
  57. import java.util.HashMap;
  58. import java.util.List;
  59. import java.util.Map;
  61. @Setter
  62. @Getter
  63. /** * 查询结果封装 */
  64. public class BaseResultVO<T> implements Serializable { 
  65.     protected T row;
  66.     protected List <T> rows;
  68.     /** * 查询得到总数据的行数 */
  69.     protected Long total;
  71.     /** * 增删改受影响的行数 */
  72.     protected Long count;
  74.     protected Double sum;
  76.     protected Double average;
  78.     protected Map <String, Object> results = new HashMap <>();
  80.     public Boolean hasData() { 
  81.         return row != null ? true : false;
  82.     }
  84.     public Boolean hasDatas() { 
  85.         if (CollectionUtils.isEmpty(rows)) { 
  86.             return false;
  87.         } else { 
  88.             return true;
  89.         }
  90.     }
  92. }

WebMvcCustomConfigurer

public class WebMvcCustomConfigurer implements WebMvcConfigurer{}
在这里处理router的，需要把他注入spring容器

发表评论

表情：
评论列表 （有 0 条评论，365人围观）

还没有评论，来说两句吧...

相关阅读