From c359bf2fb066a319a5cf4ac309ef7b0f9eb58eda Mon Sep 17 00:00:00 2001 From: tanghc Date: Thu, 28 Feb 2019 12:37:06 +0800 Subject: [PATCH] init --- .../sop/gatewaycommon/filter/BaseZuulFilter.java | 16 ++++++++++++++++ .../gatewaycommon/manager/ApiMetaContext.java | 10 ++++++++++ .../sop/gatewaycommon/result/ResultExecutor.java | 11 +++++++++++ .../sop/gatewaycommon/validate/SignEncipher.java | 1 + .../sop/servercommon/manager/ApiMetaManager.java | 4 ++++ .../manager/RequestMappingEvent.java | 4 ++++ .../servercommon/message/ServiceErrorEnum.java | 4 ++-- .../result/ServiceResultBuilder.java | 6 +++--- .../sop/bookweb/message/StoryErrorEnum.java | 4 ++-- 9 files changed, 53 insertions(+), 7 deletions(-) diff --git a/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/filter/BaseZuulFilter.java b/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/filter/BaseZuulFilter.java index d8a468a0..e5459948 100644 --- a/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/filter/BaseZuulFilter.java +++ b/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/filter/BaseZuulFilter.java @@ -17,10 +17,26 @@ public abstract class BaseZuulFilter extends ZuulFilter { private Integer filterOrder; + /** + * 获取过滤器类型 + * @return 返回FilterType + * @see ZuulFilter#filterType() filterType() + */ protected abstract FilterType getFilterType(); + /** + * 获取过滤器顺序 + * @return + * @see ZuulFilter#filterOrder() filterOrder() + */ protected abstract int getFilterOrder(); + /** + * 执行run + * @param requestContext + * @return + * @throws ZuulException + */ protected abstract Object doRun(RequestContext requestContext) throws ZuulException; /** diff --git a/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/manager/ApiMetaContext.java b/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/manager/ApiMetaContext.java index 2e5ff58d..de8a9d26 100644 --- a/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/manager/ApiMetaContext.java +++ b/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/manager/ApiMetaContext.java @@ -7,7 +7,17 @@ import org.springframework.cloud.netflix.zuul.filters.Route; * @author tanghc */ public interface ApiMetaContext { + /** + * 重新加载接口信息 + * @param serviceId + * @param serviceApiInfo + */ void reload(String serviceId, ServiceApiInfo serviceApiInfo); + /** + * 获取接口对应的route信息 + * @param nameVersion + * @return + */ Route getRoute(String nameVersion); } diff --git a/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/result/ResultExecutor.java b/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/result/ResultExecutor.java index afdd2a5f..fe98f8d5 100644 --- a/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/result/ResultExecutor.java +++ b/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/result/ResultExecutor.java @@ -4,7 +4,18 @@ package com.gitee.sop.gatewaycommon.result; * @author tanghc */ public interface ResultExecutor { + /** + * 合并结果 + * @param responseStatus + * @param responseData + * @return + */ String mergeResult(int responseStatus, String responseData); + /** + * 合并错误结果 + * @param throwable + * @return + */ String mergeError(Throwable throwable); } diff --git a/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/validate/SignEncipher.java b/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/validate/SignEncipher.java index b9aaf532..51ce0be4 100644 --- a/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/validate/SignEncipher.java +++ b/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/validate/SignEncipher.java @@ -7,6 +7,7 @@ public interface SignEncipher { /** * 签名的摘要算法 * @param input 待签名数据 + * @param secret 秘钥 * @return 返回加密后的数据 */ byte[] encrypt(String input, String secret); diff --git a/sop-server-common/src/main/java/com/gitee/sop/servercommon/manager/ApiMetaManager.java b/sop-server-common/src/main/java/com/gitee/sop/servercommon/manager/ApiMetaManager.java index 225074ce..6b0161a4 100644 --- a/sop-server-common/src/main/java/com/gitee/sop/servercommon/manager/ApiMetaManager.java +++ b/sop-server-common/src/main/java/com/gitee/sop/servercommon/manager/ApiMetaManager.java @@ -8,5 +8,9 @@ import com.gitee.sop.servercommon.bean.ServiceApiInfo; public interface ApiMetaManager { String API_STORE_KEY = "com.gitee.sop.api"; + /** + * 上传API + * @param serviceApiInfo + */ void uploadApi(ServiceApiInfo serviceApiInfo); } diff --git a/sop-server-common/src/main/java/com/gitee/sop/servercommon/manager/RequestMappingEvent.java b/sop-server-common/src/main/java/com/gitee/sop/servercommon/manager/RequestMappingEvent.java index e9031dcd..5a798ab8 100644 --- a/sop-server-common/src/main/java/com/gitee/sop/servercommon/manager/RequestMappingEvent.java +++ b/sop-server-common/src/main/java/com/gitee/sop/servercommon/manager/RequestMappingEvent.java @@ -6,5 +6,9 @@ import com.gitee.sop.servercommon.mapping.ApiMappingHandlerMapping; * @author tanghc */ public interface RequestMappingEvent { + /** + * 注册成功后回调 + * @param apiMappingHandlerMapping + */ void onRegisterSuccess(ApiMappingHandlerMapping apiMappingHandlerMapping); } diff --git a/sop-server-common/src/main/java/com/gitee/sop/servercommon/message/ServiceErrorEnum.java b/sop-server-common/src/main/java/com/gitee/sop/servercommon/message/ServiceErrorEnum.java index 2bcb981f..4849db4e 100644 --- a/sop-server-common/src/main/java/com/gitee/sop/servercommon/message/ServiceErrorEnum.java +++ b/sop-server-common/src/main/java/com/gitee/sop/servercommon/message/ServiceErrorEnum.java @@ -10,8 +10,8 @@ public enum ServiceErrorEnum { ; private ServiceErrorMeta errorMeta; - ServiceErrorEnum(String sub_code) { - this.errorMeta = new ServiceErrorMeta("isp.error_", sub_code); + ServiceErrorEnum(String subCode) { + this.errorMeta = new ServiceErrorMeta("isp.error_", subCode); } public ServiceErrorMeta getErrorMeta() { diff --git a/sop-server-common/src/main/java/com/gitee/sop/servercommon/result/ServiceResultBuilder.java b/sop-server-common/src/main/java/com/gitee/sop/servercommon/result/ServiceResultBuilder.java index bab79e6c..46713c27 100644 --- a/sop-server-common/src/main/java/com/gitee/sop/servercommon/result/ServiceResultBuilder.java +++ b/sop-server-common/src/main/java/com/gitee/sop/servercommon/result/ServiceResultBuilder.java @@ -8,11 +8,11 @@ import javax.servlet.http.HttpServletResponse; */ public interface ServiceResultBuilder { - /** * 构建错误返回结果 - * - * @param throwable 异常 + * @param request + * @param response + * @param throwable * @return 返回最终结果 */ Object buildError(HttpServletRequest request, HttpServletResponse response, Throwable throwable); diff --git a/sop-story/sop-story-web/src/main/java/com/gitee/sop/bookweb/message/StoryErrorEnum.java b/sop-story/sop-story-web/src/main/java/com/gitee/sop/bookweb/message/StoryErrorEnum.java index 5aae79ef..23c29395 100644 --- a/sop-story/sop-story-web/src/main/java/com/gitee/sop/bookweb/message/StoryErrorEnum.java +++ b/sop-story/sop-story-web/src/main/java/com/gitee/sop/bookweb/message/StoryErrorEnum.java @@ -11,8 +11,8 @@ public enum StoryErrorEnum { ; private ServiceErrorMeta errorMeta; - StoryErrorEnum(String sub_code) { - this.errorMeta = new ServiceErrorMeta("isp.error_", sub_code); + StoryErrorEnum(String subCode) { + this.errorMeta = new ServiceErrorMeta("isp.error_", subCode); } public ServiceErrorMeta getErrorMeta() {