Merge pull request #3 from sundayha/jurua-api-v0.1

Jurua api v0.1

Author: sundayha

src/main/java/com/jurua/api/JuruaApiApplication.java

@@ -4,6 +4,10 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.context.annotation.ComponentScan;
 
+/**
+ * @author 张博【[email protected]】
+ *
+ */
 @SpringBootApplication
 @ComponentScan(basePackages = "com.jurua.api")
 public class JuruaApiApplication {

src/main/java/com/jurua/api/common/constants/Constants.java

@@ -1,7 +1,8 @@
 package com.jurua.api.common.constants;
 
 /**
- * 创建人：张博
+ * @author 张博【[email protected]】
+ *
  */
 public enum StatusCode {
 

src/main/java/com/jurua/api/common/constants/StatusCode.java

@@ -0,0 +1,35 @@
+package com.jurua.api.common.constants;
+
+/**
+ * @author 张博【[email protected]】
+ *
+ * 系统常量
+ */
+public class SysConstants {
+
+    /**
+     * 登入
+     */
+    public final static String LOGIN = "/login";
+    /**
+     * swagger2的url
+     */
+    public final static String SWAGGER_URL = "/swagger-ui.html, /swagger-resources/configuration/ui, /swagger-resources, /v2/api-docs, /swagger-resources/configuration/security";
+    /**
+     * 登出path
+     */
+    public final static String LOG_OUT = "/logOut";
+    /**
+     * 用户登录时唯一的串号，这里是 require.setAttribute 以后可能删除
+     */
+    public final static String UUID = "uuid";
+    /**
+     * 令牌黑名单
+     */
+    public final static String TOKEN_BLACK_LIST = "tokenBlackList";
+
+    /**
+     * 客户端发送的 Authorization HTTP HEADER 格式是 "Bearer YOUR_JWT_TOKEN",这是OAuth的规范规定的。Bearer 后有空格
+     */
+    public final static String BEARER = "Bearer ";
+}

src/main/java/com/jurua/api/common/constants/SysConstants.java

@@ -5,9 +5,13 @@
 
 import java.io.Serializable;
 
-
+/**
+ * @author 张博【[email protected]】
+ *
+ * 分页信息
+ */
 @JsonIgnoreProperties(value = {"offset"})
-public class PagingInfo<T> implements Serializable {
+public class PagingInfo<E> implements Serializable {
     private static final long serialVersionUID = 699898315263998732L;
     @ApiModelProperty(value = "分页查询，当前要查询的页码")
     private Integer current = 1;
@@ -17,8 +21,8 @@ public class PagingInfo<T> implements Serializable {
     private Long total = 0L;
     @ApiModelProperty(value = "分页查询，查询结果的总页数")
     private Integer totalPages = 0;
-    @ApiModelProperty(value = "分页查询，查询条件所需封装的bean")
-    private T query;
+    @ApiModelProperty(value = "分页查询，查询条件所需封装的model")
+    private E query;
     @ApiModelProperty(value = "需要排序的字段")
     private String sortField;
     @ApiModelProperty(value = "需要排序的方式")
@@ -56,11 +60,11 @@ public void setTotalPages(Integer totalPages) {
         this.totalPages = totalPages;
     }
 
-    public T getQuery() {
+    public E getQuery() {
         return query;
     }
 
-    public void setQuery(T query) {
+    public void setQuery(E query) {
         this.query = query;
     }
 

src/main/java/com/jurua/api/common/model/page/PagingInfo.java

@@ -6,15 +6,16 @@
 import java.util.List;
 
 /**
- * Created by admin on 2016/8/18.
+ * @author 张博【[email protected]】
+ *
+ * 分页结果
  */
-
-public class PagingResult<T> implements Serializable {
+public class PagingResult<T, E> implements Serializable {
     private static final long serialVersionUID = -4451791256461165445L;
     @ApiModelProperty(value = "分页查询，返回的结果集合")
-    private List<T> list;//数据
+    private List<T> list;
     @ApiModelProperty(value = "分页查询，返回的分页查询条件")
-    private PagingInfo<T> page;
+    private PagingInfo<E> page;
 
     public List<T> getList() {
         return list;
@@ -24,11 +25,11 @@ public void setList(List<T> list) {
         this.list = list;
     }
 
-    public PagingInfo<T> getPage() {
+    public PagingInfo<E> getPage() {
         return page;
     }
 
-    public void setPage(PagingInfo<T> page) {
+    public void setPage(PagingInfo<E> page) {
         this.page = page;
     }
 }

src/main/java/com/jurua/api/common/model/page/PagingResult.java

@@ -5,8 +5,11 @@
 import io.swagger.annotations.ApiModelProperty;
 
 /**
- * 创建人：张博【[email protected]】
+ * @author 张博【[email protected]】
+ *
  * 时间：2017/9/6 下午4:49
+ *
+ * 响应前端结果对象
  */
 @Api(value = "ResultApi", description = "对返回结果进行统一封装")
 public class ResultApi<T> {

src/main/java/com/jurua/api/common/model/result/ResultApi.java

@@ -6,11 +6,16 @@
 
 import java.util.List;
 
+/**
+ * @author 张博【[email protected]】
+ *
+ * 整合分页结果
+ */
 public class BeanUtil {
-    public static PagingResult toPagedResultMybatis(List data, PagingInfo pageInfo) {
-        PagingResult pageResult = new PagingResult<>();
+    public static <T, E> PagingResult <T, E> toPagedResultMybatis(List<T> data, PagingInfo<E> pageInfo) {
+        PagingResult<T, E> pageResult = new PagingResult<>();
         if (data instanceof Page) {
-            Page page = (Page) data;
+            Page<T> page = (Page<T>) data;
             if (page.getPageNum() != 0) {
                 pageInfo.setCurrent(page.getPageNum());
             }

src/main/java/com/jurua/api/common/utils/BeanUtil.java

@@ -8,7 +8,8 @@
 import javax.servlet.Filter;
 
 /**
- * 创建人：张博
+ * @author 张博【[email protected]】
+ *
  */
 @Configuration
 public class AppFilterConfig {
@@ -30,14 +31,10 @@ public Filter jwtAuthenticationTokenFilter() {
      */
     @Bean
     public FilterRegistrationBean FilterRegistration() {
-        //Map<String, String> initParameters = new HashMap<>(1);
-        //initParameters.put("urls", "/v2/api-docs,/configuration/ui,/swagger-resources/**,/configuration/**,/swagger-ui.html,/webjars/**");
-        //initParameters.put("urls", "/swagger-ui.html,/webjars/*,/swagger-resources,/configuration/*,/v2/api-docs,/images/*,*");
         FilterRegistrationBean registration = new FilterRegistrationBean();
         registration.setFilter(jwtAuthenticationTokenFilter());
         registration.addUrlPatterns("/*");
         registration.setName("jwtAuthenticationTokenFilter");
-        //registration.setInitParameters(initParameters);
         return registration;
     }
 }

src/main/java/com/jurua/api/config/Filter/AppFilterConfig.java

@@ -10,7 +10,8 @@
 import org.springframework.web.bind.annotation.ResponseBody;
 
 /**
- * 创建人：张博
+ * @author 张博【[email protected]】
+ *
  */
 @ControllerAdvice
 public class GlobalExceptionHandler {