通用的 核心模块

在 ruoyi-common 模块下，创建通用的核心子模块 ruoyi-common-core ,其 pom.xml 内容：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <groupId>com.ruoyi</groupId>
  7.         <artifactId>ruoyi-common</artifactId>
  8.         <version>1.0.0</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>ruoyi-common-core</artifactId>
  15. </project>

版本号声明

在 ruoyi 父工程中，声明版本号

  1.             <dependency>
  2.                 <groupId>com.ruoyi</groupId>
  3.                 <artifactId>ruoyi-common-core</artifactId>
  4.                 <version>${ruoyi.version}</version>
  5.             </dependency>

通用的返回结果集

  1. package com.ruoyi.common.core.domain;
  3. import com.ruoyi.common.core.constant.Constants;
  5. import java.io.Serializable;
  7. /**
  8.  * 响应信息主体
  9.  *
  10.  * @author ruoyi
  11.  */
  12. public class R<T> implements Serializable {
  13.     private static final long serialVersionUID = 1L;
  15.     /**
  16.      * 成功
  17.      */
  18.     public static final int SUCCESS = Constants.SUCCESS;
  20.     /**
  21.      * 失败
  22.      */
  23.     public static final int FAIL = Constants.FAIL;
  25.     private int code;
  27.     private String msg;
  29.     private T data;
  31.     public static <T> R<T> ok() {
  32.         return restResult(null, SUCCESS, null);
  33.     }
  35.     public static <T> R<T> ok(T data) {
  36.         return restResult(data, SUCCESS, null);
  37.     }
  39.     public static <T> R<T> ok(T data, String msg) {
  40.         return restResult(data, SUCCESS, msg);
  41.     }
  43.     public static <T> R<T> fail() {
  44.         return restResult(null, FAIL, null);
  45.     }
  47.     public static <T> R<T> fail(String msg) {
  48.         return restResult(null, FAIL, msg);
  49.     }
  51.     public static <T> R<T> fail(T data) {
  52.         return restResult(data, FAIL, null);
  53.     }
  55.     public static <T> R<T> fail(T data, String msg) {
  56.         return restResult(data, FAIL, msg);
  57.     }
  59.     public static <T> R<T> fail(int code, String msg) {
  60.         return restResult(null, code, msg);
  61.     }
  63.     private static <T> R<T> restResult(T data, int code, String msg) {
  64.         R<T> apiResult = new R<>();
  65.         apiResult.setCode(code);
  66.         apiResult.setData(data);
  67.         apiResult.setMsg(msg);
  68.         return apiResult;
  69.     }
  71.     public int getCode() {
  72.         return code;
  73.     }
  75.     public void setCode(int code) {
  76.         this.code = code;
  77.     }
  79.     public String getMsg() {
  80.         return msg;
  81.     }
  83.     public void setMsg(String msg) {
  84.         this.msg = msg;
  85.     }
  87.     public T getData() {
  88.         return data;
  89.     }
  91.     public void setData(T data) {
  92.         this.data = data;
  93.     }
  94. }

通用常量类

  1. package com.ruoyi.common.core.constant;
  3. /**
  4.  * 通用常量信息
  5.  *
  6.  * @author ruoyi
  7.  */
  8. public class Constants {
  9.     /**
  10.      * UTF-8 字符集
  11.      */
  12.     public static final String UTF8 = "UTF-8";
  14.     /**
  15.      * GBK 字符集
  16.      */
  17.     public static final String GBK = "GBK";
  19.     /**
  20.      * http请求
  21.      */
  22.     public static final String HTTP = "http://";
  24.     /**
  25.      * https请求
  26.      */
  27.     public static final String HTTPS = "https://";
  29.     /**
  30.      * 成功标记
  31.      */
  32.     public static final Integer SUCCESS = 200;
  34.     /**
  35.      * 失败标记
  36.      */
  37.     public static final Integer FAIL = 500;
  39.     /**
  40.      * 登录成功
  41.      */
  42.     public static final String LOGIN_SUCCESS = "Success";
  44.     /**
  45.      * 注销
  46.      */
  47.     public static final String LOGOUT = "Logout";
  49.     /**
  50.      * 注册
  51.      */
  52.     public static final String REGISTER = "Register";
  54.     /**
  55.      * 登录失败
  56.      */
  57.     public static final String LOGIN_FAIL = "Error";
  59.     /**
  60.      * 当前记录起始索引
  61.      */
  62.     public static final String PAGE_NUM = "pageNum";
  64.     /**
  65.      * 每页显示记录数
  66.      */
  67.     public static final String PAGE_SIZE = "pageSize";
  69.     /**
  70.      * 排序列
  71.      */
  72.     public static final String ORDER_BY_COLUMN = "orderByColumn";
  74.     /**
  75.      * 排序的方向 "desc" 或者 "asc".
  76.      */
  77.     public static final String IS_ASC = "isAsc";
  79.     /**
  80.      * 验证码 redis key
  81.      */
  82.     public static final String CAPTCHA_CODE_KEY = "captcha_codes:";
  84.     /**
  85.      * 验证码有效期（分钟）
  86.      */
  87.     public static final long CAPTCHA_EXPIRATION = 2;
  89.     /**
  90.      * 令牌有效期（分钟）
  91.      */
  92.     public final static long TOKEN_EXPIRE = 720;
  94.     /**
  95.      * 参数管理 cache key
  96.      */
  97.     public static final String SYS_CONFIG_KEY = "sys_config:";
  99.     /**
  100.      * 字典管理 cache key
  101.      */
  102.     public static final String SYS_DICT_KEY = "sys_dict:";
  104.     /**
  105.      * 资源映射路径 前缀
  106.      */
  107.     public static final String RESOURCE_PREFIX = "/profile";
  108. }

使用

别的模块如果要使用的话，只需要引入该模块

  1.        <dependency>
  2.             <groupId>com.ruoyi</groupId>
  3.             <artifactId>ruoyi-common-core</artifactId>
  4.         </dependency>