• 2、云原生微服务实践-服务开发框架设计和实践

    目录

    一、依赖管理

    二、服务模块管理 api、svc

    三、其他文件管理

    1、私密配置文件

    2、前端页面单页文件

    四、单体仓库 mono-repo

    1、单体仓库和多仓库的对比： 

    2、单体仓库优点

    五、接口参数校验

    六、统一异常处理

    七、DTO(数据传输对象)和DMO(数据模型对象)

    八、强类型接口设计

    1、特点：接口规划、编译器自动类型检查、自动代码生成。但是客户端和服务端耦合性大

    2、Spring Feign

    一、依赖管理

    JavaSpring项目使用Maven管理所有微服务先继承实现父模块依赖，根据自己模块业务再附加依赖。common-lib公共共享模块，服务开发封装类。

    二、服务模块管理 api、svc

    每个服务由两个模块组成，接口模块和服务模块，例如account-aip、account-svc，一般api接口模块上传到maven仓库进行管理，api为强类型客户端，其他服务调用相关服务的api即可。

    三、其他文件管理

    1、私密配置文件

    除了服务外还有config目录进行对私密文件的存储，使用spring的本地私密配置方式，config里面的私密控制不会被监听到版本控制。

    2、前端页面单页文件

    四、单体仓库 mono-repo

    1、单体仓库和多仓库的对比： 

    2、单体仓库优点

    • 易于规范代码风格
    • 易于集成和部署，配合构建工具可以一键部署
    • 易于理解，方便开发人员把握整体建构
    • 易于复用，可以抽取公共功能，进行重构

    五、接口参数校验

    spring有成套且成熟的校验注解，开发成员只需要填写注释。开发人员也可以根据自己的业务校验规则定义注解，实现ConstraintValidator，重写校验规则即可。

    例如：

    六、统一异常处理

    1. package xyz.staffjoy.common.error;
    2.  
    3. import com.github.structlog4j.ILogger;
    4. import com.github.structlog4j.SLoggerFactory;
    5. import org.hibernate.validator.internal.engine.path.PathImpl;
    6. import org.springframework.http.converter.HttpMessageNotReadableException;
    7. import org.springframework.validation.BindException;
    8. import org.springframework.validation.BindingResult;
    9. import org.springframework.validation.FieldError;
    10. import org.springframework.web.HttpMediaTypeNotSupportedException;
    11. import org.springframework.web.HttpRequestMethodNotSupportedException;
    12. import org.springframework.web.bind.MethodArgumentNotValidException;
    13. import org.springframework.web.bind.MissingServletRequestParameterException;
    14. import org.springframework.web.bind.annotation.*;
    15. import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
    16. import org.springframework.web.servlet.NoHandlerFoundException;
    17. import xyz.staffjoy.common.api.BaseResponse;
    18. import xyz.staffjoy.common.api.ResultCode;
    19. import xyz.staffjoy.common.auth.PermissionDeniedException;
    20.  
    21. import javax.validation.ConstraintViolation;
    22. import javax.validation.ConstraintViolationException;
    23. import java.util.Set;
    24.  
    25. @RestControllerAdvice
    26. public class GlobalExceptionTranslator {
    27.  
    28.     static final ILogger logger = SLoggerFactory.getLogger(GlobalExceptionTranslator.class);
    29.  
    30.     @ExceptionHandler(MissingServletRequestParameterException.class)
    31.     public BaseResponse handleError(MissingServletRequestParameterException e) {
    32.         logger.warn("Missing Request Parameter", e);
    33.         String message = String.format("Missing Request Parameter: %s", e.getParameterName());
    34.         return BaseResponse
    35.                 .builder()
    36.                 .code(ResultCode.PARAM_MISS)
    37.                 .message(message)
    38.                 .build();
    39.     }
    40.  
    41.     @ExceptionHandler(MethodArgumentTypeMismatchException.class)
    42.     public BaseResponse handleError(MethodArgumentTypeMismatchException e) {
    43.         logger.warn("Method Argument Type Mismatch", e);
    44.         String message = String.format("Method Argument Type Mismatch: %s", e.getName());
    45.         return BaseResponse
    46.                 .builder()
    47.                 .code(ResultCode.PARAM_TYPE_ERROR)
    48.                 .message(message)
    49.                 .build();
    50.     }
    51.  
    52.     @ExceptionHandler(MethodArgumentNotValidException.class)
    53.     public BaseResponse handleError(MethodArgumentNotValidException e) {
    54.         logger.warn("Method Argument Not Valid", e);
    55.         BindingResult result = e.getBindingResult();
    56.         FieldError error = result.getFieldError();
    57.         String message = String.format("%s:%s", error.getField(), error.getDefaultMessage());
    58.         return BaseResponse
    59.                 .builder()
    60.                 .code(ResultCode.PARAM_VALID_ERROR)
    61.                 .message(message)
    62.                 .build();
    63.     }
    64.  
    65.     @ExceptionHandler(BindException.class)
    66.     public BaseResponse handleError(BindException e) {
    67.         logger.warn("Bind Exception", e);
    68.         FieldError error = e.getFieldError();
    69.         String message = String.format("%s:%s", error.getField(), error.getDefaultMessage());
    70.         return BaseResponse
    71.                 .builder()
    72.                 .code(ResultCode.PARAM_BIND_ERROR)
    73.                 .message(message)
    74.                 .build();
    75.     }
    76.  
    77.     @ExceptionHandler(ConstraintViolationException.class)
    78.     public BaseResponse handleError(ConstraintViolationException e) {
    79.         logger.warn("Constraint Violation", e);
    80.         Set> violations = e.getConstraintViolations();
    81.         ConstraintViolation violation = violations.iterator().next();
    82.         String path = ((PathImpl) violation.getPropertyPath()).getLeafNode().getName();
    83.         String message = String.format("%s:%s", path, violation.getMessage());
    84.         return BaseResponse
    85.                 .builder()
    86.                 .code(ResultCode.PARAM_VALID_ERROR)
    87.                 .message(message)
    88.                 .build();
    89.     }
    90.  
    91.     @ExceptionHandler(NoHandlerFoundException.class)
    92.     public BaseResponse handleError(NoHandlerFoundException e) {
    93.         logger.error("404 Not Found", e);
    94.         return BaseResponse
    95.                 .builder()
    96.                 .code(ResultCode.NOT_FOUND)
    97.                 .message(e.getMessage())
    98.                 .build();
    99.     }
    100.  
    101.     @ExceptionHandler(HttpMessageNotReadableException.class)
    102.     public BaseResponse handleError(HttpMessageNotReadableException e) {
    103.         logger.error("Message Not Readable", e);
    104.         return BaseResponse
    105.                 .builder()
    106.                 .code(ResultCode.MSG_NOT_READABLE)
    107.                 .message(e.getMessage())
    108.                 .build();
    109.     }
    110.  
    111.     @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    112.     public BaseResponse handleError(HttpRequestMethodNotSupportedException e) {
    113.         logger.error("Request Method Not Supported", e);
    114.         return BaseResponse
    115.                 .builder()
    116.                 .code(ResultCode.METHOD_NOT_SUPPORTED)
    117.                 .message(e.getMessage())
    118.                 .build();
    119.     }
    120.  
    121.     @ExceptionHandler(HttpMediaTypeNotSupportedException.class)
    122.     public BaseResponse handleError(HttpMediaTypeNotSupportedException e) {
    123.         logger.error("Media Type Not Supported", e);
    124.         return BaseResponse
    125.                 .builder()
    126.                 .code(ResultCode.MEDIA_TYPE_NOT_SUPPORTED)
    127.                 .message(e.getMessage())
    128.                 .build();
    129.     }
    130.  
    131.     @ExceptionHandler(ServiceException.class)
    132.     public BaseResponse handleError(ServiceException e) {
    133.         logger.error("Service Exception", e);
    134.         return BaseResponse
    135.                 .builder()
    136.                 .code(e.getResultCode())
    137.                 .message(e.getMessage())
    138.                 .build();
    139.     }
    140.  
    141.     @ExceptionHandler(PermissionDeniedException.class)
    142.     public BaseResponse handleError(PermissionDeniedException e) {
    143.         logger.error("Permission Denied", e);
    144.         return BaseResponse
    145.                 .builder()
    146.                 .code(e.getResultCode())
    147.                 .message(e.getMessage())
    148.                 .build();
    149.     }
    150.  
    151.     @ExceptionHandler(Throwable.class)
    152.     public BaseResponse handleError(Throwable e) {
    153.         logger.error("Internal Server Error", e);
    154.         return BaseResponse
    155.                 .builder()
    156.                 .code(ResultCode.INTERNAL_SERVER_ERROR)
    157.                 .message(e.getMessage())
    158.                 .build();
    159.     }
    160. }

    1. package xyz.staffjoy.common.error;
    2.  
    3. import lombok.Getter;
    4. import xyz.staffjoy.common.api.ResultCode;
    5.  
    6. /**
    7.  * Business Service Exception
    8.  *
    9.  * @author william
    10.  */
    11. public class ServiceException extends RuntimeException {
    12.     private static final long serialVersionUID = 2359767895161832954L;
    13.  
    14.     @Getter
    15.     private final ResultCode resultCode;
    16.  
    17.     public ServiceException(String message) {
    18.         super(message);
    19.         this.resultCode = ResultCode.FAILURE;
    20.     }
    21.  
    22.     public ServiceException(ResultCode resultCode) {
    23.         super(resultCode.getMsg());
    24.         this.resultCode = resultCode;
    25.     }
    26.  
    27.     public ServiceException(ResultCode resultCode, String msg) {
    28.         super(msg);
    29.         this.resultCode = resultCode;
    30.     }
    31.  
    32.     public ServiceException(ResultCode resultCode, Throwable cause) {
    33.         super(cause);
    34.         this.resultCode = resultCode;
    35.     }
    36.  
    37.     public ServiceException(String msg, Throwable cause) {
    38.         super(msg, cause);
    39.         this.resultCode = ResultCode.FAILURE;
    40.     }
    41.  
    42.     /**
    43.      * for better performance
    44.      *
    45.      * @return Throwable
    46.      */
    47.     @Override
    48.     public Throwable fillInStackTrace() {
    49.         return this;
    50.     }
    51.  
    52.     public Throwable doFillInStackTrace() {
    53.         return super.fillInStackTrace();
    54.     }
    55. }

    七、DTO(数据传输对象)和DMO(数据模型对象)

    dto与dmo互转：

    转换工具地址：https://github.com/modelmapper/modelmapper

    modelmap使用详情：https://blog.csdn.net/m0_54797663/article/details/115277264

    八、强类型接口设计

    1、特点：接口规划、编译器自动类型检查、自动代码生成。但是客户端和服务端耦合性大

    通过Spring Feign结合强、若类型的结合，既能达到强类型接口的规范性又能达到弱类型接口的解耦性。

    2、Spring Feign

    注意：返回类型如果根据泛型进行包装的，springfeign是无法解析的，因为编译之后的泛型会被擦除！  

    九、环境隔离

    1. public class EnvConstant {
    2.     public static final String ENV_DEV = "dev";
    3.     public static final String ENV_TEST = "test";
    4.     public static final String ENV_UAT = "uat"; // similar to staging
    5.     public static final String ENV_PROD = "prod";
    6. }
    1. package xyz.staffjoy.common.env;
    2.  
    3. import lombok.*;
    4.  
    5. import java.util.HashMap;
    6. import java.util.Map;
    7.  
    8. // environment related configuration
    9. @Data
    10. @Builder
    11. public class EnvConfig {
    12.  
    13.     private String name;
    14.     private boolean debug;
    15.     private String externalApex;
    16.     private String internalApex;
    17.     private String scheme;
    18.  
    19.     @Getter(AccessLevel.NONE)
    20.     @Setter(AccessLevel.NONE)
    21.     private static Map map;
    22.  
    23.     static {
    24.         map = new HashMap();
    25.         EnvConfig envConfig = EnvConfig.builder().name(EnvConstant.ENV_DEV)
    26.                 .debug(true)
    27.                 .externalApex("staffjoy-v2.local")
    28.                 .internalApex(EnvConstant.ENV_DEV)
    29.                 .scheme("http")
    30.                 .build();
    31.         map.put(EnvConstant.ENV_DEV, envConfig);
    32.  
    33.         envConfig = EnvConfig.builder().name(EnvConstant.ENV_TEST)
    34.                 .debug(true)
    35.                 .externalApex("staffjoy-v2.local")
    36.                 .internalApex(EnvConstant.ENV_DEV)
    37.                 .scheme("http")
    38.                 .build();
    39.         map.put(EnvConstant.ENV_TEST, envConfig);
    40.  
    41.         // for aliyun k8s demo, enable debug and use http and staffjoy-uat.local
    42.         // in real world, disable debug and use http and staffjoy-uat.xyz in UAT environment
    43.         envConfig = EnvConfig.builder().name(EnvConstant.ENV_UAT)
    44.                 .debug(true)
    45.                 .externalApex("staffjoy-uat.local")
    46.                 .internalApex(EnvConstant.ENV_UAT)
    47.                 .scheme("http")
    48.                 .build();
    49.         map.put(EnvConstant.ENV_UAT, envConfig);
    50.  
    51. //        envConfig = EnvConfig.builder().name(EnvConstant.ENV_UAT)
    52. //                .debug(false)
    53. //                .externalApex("staffjoy-uat.xyz")
    54. //                .internalApex(EnvConstant.ENV_UAT)
    55. //                .scheme("https")
    56. //                .build();
    57. //        map.put(EnvConstant.ENV_UAT, envConfig);
    58.  
    59.         envConfig = EnvConfig.builder().name(EnvConstant.ENV_PROD)
    60.                 .debug(false)
    61.                 .externalApex("staffjoy.com")
    62.                 .internalApex(EnvConstant.ENV_PROD)
    63.                 .scheme("https")
    64.                 .build();
    65.         map.put(EnvConstant.ENV_PROD, envConfig);
    66.     }
    67.  
    68.     public static EnvConfig getEnvConfg(String env) {
    69.         EnvConfig envConfig = map.get(env);
    70.         if (envConfig == null) {
    71.             envConfig = map.get(EnvConstant.ENV_DEV);
    72.         }
    73.         return envConfig;
    74.     }
    75. }

    十、异步调用处理

    配置异步线程池：

    1. package xyz.staffjoy.account.config;
    2.  
    3. import org.springframework.context.annotation.Bean;
    4. import org.springframework.context.annotation.Configuration;
    5. import org.springframework.context.annotation.Import;
    6. import org.springframework.scheduling.annotation.EnableAsync;
    7. import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
    8. import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
    9. import org.springframework.security.crypto.password.PasswordEncoder;
    10. import xyz.staffjoy.common.async.ContextCopyingDecorator;
    11. import xyz.staffjoy.common.config.StaffjoyRestConfig;
    12.  
    13. import java.util.concurrent.Executor;
    14.  
    15. @Configuration
    16. @EnableAsync
    17. @Import(value = {StaffjoyRestConfig.class})
    18. @SuppressWarnings(value = "Duplicates")
    19. public class AppConfig {
    20.  
    21.     public static final String ASYNC_EXECUTOR_NAME = "asyncExecutor";
    22.  
    23.     @Bean(name=ASYNC_EXECUTOR_NAME)
    24.     public Executor asyncExecutor() {
    25.         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
    26.         // for passing in request scope context
    27.         executor.setTaskDecorator(new ContextCopyingDecorator());
    28.         executor.setCorePoolSize(3);
    29.         executor.setMaxPoolSize(5);
    30.         executor.setQueueCapacity(100);
    31.         executor.setWaitForTasksToCompleteOnShutdown(true);
    32.         executor.setThreadNamePrefix("AsyncThread-");
    33.         executor.initialize();
    34.         return executor;
    35.     }
    36.  
    37.     @Bean
    38.     public PasswordEncoder passwordEncoder() {
    39.         return new BCryptPasswordEncoder();
    40.     }
    41.  
    42. }

    注意：调用方与被调用方不能在同一个bean中。

    十二、集成Swagger文档

    SpringBoot引入swagger依赖

    2.             io.springfox
    3.             springfox-swagger2
    4.         
    5.         
    6.             io.springfox
    7.             springfox-swagger-ui
    8.         
    1. package xyz.staffjoy.account.config;
    2.  
    3. import org.springframework.context.annotation.Bean;
    4. import org.springframework.context.annotation.Configuration;
    5. import springfox.documentation.builders.ApiInfoBuilder;
    6. import springfox.documentation.builders.PathSelectors;
    7. import springfox.documentation.builders.RequestHandlerSelectors;
    8. import springfox.documentation.service.ApiInfo;
    9. import springfox.documentation.service.Contact;
    10. import springfox.documentation.spi.DocumentationType;
    11. import springfox.documentation.spring.web.plugins.Docket;
    12. import springfox.documentation.swagger2.annotations.EnableSwagger2;
    13.  
    14. @Configuration
    15. @EnableSwagger2
    16. public class SwaggerConfig {
    17.     @Bean
    18.     public Docket api() {
    19.         return new Docket(DocumentationType.SWAGGER_2)
    20.                 .select()
    21.                 .apis(RequestHandlerSelectors.basePackage("xyz.staffjoy.account.controller"))
    22.                 .paths(PathSelectors.any())
    23.                 .build()
    24.                 .apiInfo(apiEndPointsInfo())
    25.                 .useDefaultResponseMessages(false);
    26.     }
    27.  
    28.     private ApiInfo apiEndPointsInfo() {
    29.         return new ApiInfoBuilder().title("Account REST API")
    30.                 .description("Staffjoy Account REST API")
    31.                 .contact(new Contact("bobo", "https://github.com/jskillcloud", "bobo@jskillcloud.com"))
    32.                 .license("The MIT License")
    33.                 .licenseUrl("https://opensource.org/licenses/MIT")
    34.                 .version("V2")
    35.                 .build();
    36.     }
    37. }

     十三、常用框架和比对

     

  • 相关阅读:
    Overleaf能使用自己系统中的字体嘛？
    夯基提质｜正雅膜片及附件定位系统双升级
    Redis的事务管理
    Codeforces Round 888 (Div. 3)
    安卓实训作孽之Linux命令手册
    Delete `␍` 最简单最有效的解决方法和解释（VScode）
    Certbot免费的HTTPS证书
    【内网安全】横向移动-IPC
    网络安全（黑客）自学
    深入理解 Java 对象的内存布局
  • 原文地址：https://blog.csdn.net/kk_lina/article/details/127703463