Dew-Framework（轻量服务框架）

此章节关联示例:bone-example

<!--引入Dew父依赖，也可以使用import方式-->
<parent>
    <groupId>com.tairanchina.csp.dew</groupId>
    <artifactId>parent-starter</artifactId>
    <!--生产环境请选择合适的版本!!!!!!!!-->
    <version>${dew.version}</version>
</parent>
...
<dependencies>
    <!--引入需要的模块-->
    <dependency>
        <groupId>com.tairanchina.csp.dew</groupId>
        <artifactId><模块名></artifactId>
    </dependency>
</dependencies>
...
<!--开发者-->
<developers>
    <developer>
        <name></name>
        <email></email>
    </developer>
</developers>
<!--SCM信息-->
<scm>
    <connection></connection>
    <developerConnection></developerConnection>
    <url></url>
</scm>

|- common-service
|   |- src
|   |   |- main
|   |   |   |- java
|   |   |   |   |- src
|   |   |   |   |   |- x.y.z
|   |   |   |   |   |   |- XApplication (1)
|   |   |   |   |   |   |- XConfig (2)
|   |   |   |   |   |   |- XInitiator (3)

#指定属于哪个zone
eureka:
  instance:
    metadata-map:
      zone: #zone 名称

#指定region（此处region为项目在不同区域的部署，为项目规范，不同region间能互相调用）
eureka:
  client:
    region: #region名称

@PostMapping(value = "ca/all", consumes = MediaType.APPLICATION_JSON_VALUE)
Resp<CustomerInfoVO> applyCA(@RequestBody CAIdentificationDTO params,
     @RequestHeader Map<String, Object> headers);

        <dependency>
            <groupId>io.github.openfeign.form</groupId>
            <artifactId>feign-form</artifactId>
            <version>3.0.1</version>
        </dependency>
        <dependency>
            <groupId>io.github.openfeign.form</groupId>
            <artifactId>feign-form-spring</artifactId>
            <version>3.0.1</version>
        </dependency>

import feign.codec.Encoder;
import feign.form.spring.SpringFormEncoder;
import org.springframework.beans.factory.ObjectFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.web.HttpMessageConverters;
import org.springframework.cloud.netflix.feign.support.SpringEncoder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MultipartSupportConfig {

    @Autowired
    private ObjectFactory<HttpMessageConverters> messageConverters;

    @Bean
    public Encoder feignFormEncoder() {
        return new SpringFormEncoder(new SpringEncoder(messageConverters));
    }

}

@FeignClient(name = "demo")
public interface FeginExample {
@PostMapping(value = "images", consumes = MULTIPART_FORM_DATA_VALUE)
 Resp<String> uploadImage(
            @RequestParam MultipartFile image,
            @RequestParam("id") String id);
}

@RestController
public class FeginServiceExample {
  @PostMapping(value = "images", consumes = MULTIPART_FORM_DATA_VALUE)
    public Resp<String> uploadImage(
            @RequestParam("image") MultipartFile image,
            @RequestParam("id") String id,
            HttpServletRequest request) {
              return Resp.success(null);
            }
}

请求文件参数的名称与实际接口接受名称不一致

转换器没有生效，检查一下MultipartSupportConfig

public class HelloHystrixCommand extends HystrixCommand<HelloHystrixCommand.Model> {

    public static final Logger logger = LoggerFactory.getLogger(HelloHystrixCommand.class);

    private Model model;

    protected HelloHystrixCommand(HystrixCommandGroupKey group) {
        super(group);
    }

    protected HelloHystrixCommand(HystrixCommandGroupKey group, HystrixThreadPoolKey threadPool) {
        super(group, threadPool);
    }

    protected HelloHystrixCommand(HystrixCommandGroupKey group, int executionIsolationThreadTimeoutInMilliseconds) {
        super(group, executionIsolationThreadTimeoutInMilliseconds);
    }

    protected HelloHystrixCommand(HystrixCommandGroupKey group, HystrixThreadPoolKey threadPool, int executionIsolationThreadTimeoutInMilliseconds) {
        super(group, threadPool, executionIsolationThreadTimeoutInMilliseconds);
    }

    protected HelloHystrixCommand(Setter setter) {
        super(setter);
    }

    public static HelloHystrixCommand getInstance(String key){
        return new HelloHystrixCommand(HystrixCommandGroupKey.Factory.asKey(key));
    }

    @Override
    protected Model run() throws Exception {
        int i = 1 / 0;
        logger.info("run:   thread id:  " + Thread.currentThread().getId());
        return model;
    }

    @Override
    protected Model getFallback() {
        return new Model("fallback");
    }

    public static void main(String[] args) throws Exception {
        HelloHystrixCommand helloHystrixCommand = HelloHystrixCommand.getInstance("dew");
        helloHystrixCommand.model = helloHystrixCommand.new Model("run");
        logger.info("main:      " + helloHystrixCommand.model + "thread id: " + Thread.currentThread().getId());
        System.out.println(helloHystrixCommand.execute());

    }


    class Model {

        public Model(String name) {
            this.name = name;
        }

        private String name;

        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }

        @Override
        public String toString() {
            return "Model{" +
                    "name='" + name + '\'' +
                    '}';
        }
    }
}

# 执行的隔离策略 THREAD, SEMAPHORE 默认THREAD
hystrix.command.default.execution.isolation.strategy=THREAD
# 执行hystrix command的超时时间,超时后会进入fallback方法 默认1000
hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds=1000
# 执行hystrix command是否限制超时,默认是true
hystrix.command.default.execution.timeout.enabled=true
# hystrix command 执行超时后是否中断 默认true
hystrix.command.default.execution.isolation.thread.interruptOnTimeout=true
# 使用信号量隔离时,信号量大小,默认10
hystrix.command.default.execution.isolation.semaphore.maxConcurrentRequests=10
# fallback方法最大并发请求数 默认是10
hystrix.command.default.fallback.isolation.semaphore.maxConcurrentRequests=10
# 服务降级是否开启,默认为true
hystrix.command.default.fallback.enabled=true
# 是否使用断路器来跟踪健康指标和熔断请求
hystrix.command.default.circuitBreaker.enabled=true
# 熔断器的最小请求数,默认20. (这个不是很理解,欢迎补充)
hystrix.command.default.circuitBreaker.requestVolumeThreshold=20
# 断路器打开后的休眠时间,默认5000
hystrix.command.default.circuitBreaker.sleepWindowInMilliseconds=5000
# 断路器打开的容错比,默认50
hystrix.command.default.circuitBreaker.errorThresholdPercentage=50
# 强制打开断路器,拒绝所有请求. 默认false, 优先级高于forceClosed
hystrix.command.default.circuitBreaker.forceOpen=false
# 强制关闭断路器,接收所有请求,默认false,优先级低于forceOpen
hystrix.command.default.circuitBreaker.forceClosed=false

# hystrix command 命令执行核心线程数,最大并发 默认10
hystrix.threadpool.default.coreSize=10

public class HystrixExampleService {
    @HystrixCommand(fallbackMethod = "defaultFallback", commandProperties = {
            @HystrixProperty(name = "execution.isolation.thread.timeoutInMilliseconds", value = "2000")
    })
    public String someMethod(Map<String, Object> parameters, DewContext context) {
        // ！！！ Hystrix使用新线程执行代码，导致Threadlocal数据不能同步，
        // 使用时需要将用到的数据做为参数传入，如果需要使用Dew框架的上下文需要先传入再设值
        DewContext.setContext(context);
        try {
            Thread.sleep(new Random().nextInt(3000));
            logger.info("Normal Service Token:" + Dew.context().getToken());
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
        }
        return "ok";
    }

    // 降级处理方法定义
    public String defaultFallback(Map<String, Object> parameters, DewContext context, Throwable e) {
        DewContext.setContext(context);
        logger.info("Error Service Token:" + Dew.context().getToken());
        return "fail";
    }
}

@Configuration
@EnableScheduling
public class SchedulingConfiguration implements SchedulingConfigurer {

    private Logger logger = LoggerFactory.getLogger(SchedulingConfiguration.class);

    @Autowired
    private ConfigExampleConfig config;

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.addTriggerTask(() -> logger.info("task1: " + config.getVersion()), triggerContext -> {
            Instant instant = Instant.now().plus(5, SECONDS);
            return Date.from(instant);
        });

        taskRegistrar.addTriggerTask(() -> logger.info("task2: " + config.getVersion()), new CronTrigger("1/3 * * * * ?"));
    }
}

zuul: #配置一项即可!
  ignored-patterns: /dew-example/**   #排除此路径
  ignored-services: dew-example       #排除此服务

@Bean
RedisCacheManager cacheManager() {
    final RedisCacheManager redisCacheManager = new RedisCacheManager(redisTemplate);
    redisCacheManager.setUsePrefix(true);
    redisCacheManager.setDefaultExpiration(<过期秒数>);
    return redisCacheManager;
}

management:
  security:
    enabled: false # 关闭管理认证
  context-path: /management (1)
eureka:
  instance:
    metadata-map:
      cluster: default (2)

spring:
  application:
    name: monitor
  boot:
    admin:
      discovery:
        converter:
          management-context-path: ${management.context-path}
      routes:
        endpoints: env,metrics,dump,jolokia,info,configprops,trace,logfile,refresh,flyway,liquibase,heapdump,loggers,auditevents,hystrix.stream,turbine.stream  (1)
      turbine:
        clusters: default  (2)
        location: ${spring.application.name}

turbine:
  instanceUrlSuffix: ${management.context-path}/hystrix.stream
  aggregator:
    clusterConfig: default (2)
  appConfig: monitor-example,hystrix-example (3)
  clusterNameExpression: metadata['cluster']

security:
  basic:
    enabled: false

server:
  port: ...

eureka:
  instance:
    metadata-map:
      cluster: default (2)
  client:
    serviceUrl:
      defaultZone: ...

management:
  security:
    enabled: false
  context-path: /management (4)

spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/dew?useUnicode=true&characterEncoding=utf-8&rewriteBatchedStatements=true
    username: root
    password: 123456

public class TestConverter extends DynamicConverter<ILoggingEvent> {

    @Override
    public String convert(ILoggingEvent event) {
        // 这里未做解析，示例代码
        return event.getMessage();
    }
}

# MySQL环境
docker run -d --name dew-mysql -p 3306:3306 -e MYSQL_DATABASE=dew -e MYSQL_ROOT_PASSWORD=123456 mysql
# Redis环境
docker run -d --name dew-redis -p 6379:6379 redis
# Rabbit环境
docker run -d --name dew-rabbit --hostname dew-rabbit -p 15671:15671 -p 15672:15672 -p 4369:4369 -p 5671:5671 -p 5672:5672 -p 25672:25672 -e RABBITMQ_DEFAULT_USER=root -e RABBITMQ_DEFAULT_PASS=123456 -e RABBITMQ_DEFAULT_VHOST=dew rabbitmq:3-management-alpine
# Hazelcast环境
docker run -d --name dew-hazelcast -p 5701:5701 hazelcast/hazelcast
# Zookeeper环境
docker run -d --name dew-zookeeper -p 2181 -t wurstmeister/zookeeper
# Kafka环境
docker run --name dew-kafka -e HOST_IP=localhost -e KAFKA_ADVERTISED_PORT=9092 -e KAFKA_BROKER_ID=1 -e ZK=zk -p 9092:9092 --link dew-zookeeper:zk -t wurstmeister/kafka

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <optional>true</optional>
</dependency>

dew: # Dew 参数key前缀
    basic: # 基础信息
        name: # 服务名称，用于API文档显示等
        version: 1.0 # 服务版本号，用于API文档显示等
        desc: # 服务描述，用于API文档显示等
        webSite: # 官网，用于API文档显示等
        doc:
            enabled: true # 是否启用默认文档配置，关闭后可自定义文档管理，默认为true
            base-package: # API文档要扫描的根包，多指定到 Controller 包中
            contact: # 联系人信息
                name: # 联系人姓名
                url: # 联系人URL
                email: # 联系人邮箱
        format:
            use-unity-error: true # 是否启用统一响应
            error-flag: __DEW_ERROR__ # 默认的通知标识
        error-mapping: # 自定义错误映射
            "[<异常类名>]":
                http-code: # http状态码，不存在时使用实例级http状态码
                business-code: # 业务编码，不存在时使用实例级业务编码
                message: # 错误描述，不存在时使用实例级错误描述
    cluster: # 集群功能
        cache: redis # 缓存实现
        lock: redis # 分布式锁实现，可选 redis/hazelcast，默认redis
        map: redis # 分布式Map实现，可选 redis/hazelcast，默认redis
        mq: redis # MQ实现，可选 redis/hazelcast/rabbit，默认redis
        election: redis # 领导者选举实现，可选 redis/eureka，默认redis
        config: #集群相关配置
            election-period-sec: 60 #领导者选举时间区间，默认60秒
            ha-enabled: true #是否启用HA，默认为true
    notifies:
        "": # 通知的标识
            type: DD # 通知的类型，DD=钉钉 MAIL=邮件，邮件方式需要有配置spring.mail下相关的smtp信息 HTTP=自定义HTTP Hook
            defaultReceivers: # 默认接收人列表，钉钉为手机号，邮件为邮箱
            dndTimeReceivers: # 免扰时间内的接收人列表，只有该列表中的接收人才能在免扰时间内接收通知
            args: # 不同类型的参数，邮件不需要设置
                url: # 钉钉的推送地址，说明详见：https://open-doc.dingtalk.com/docs/doc.htm?spm=a219a.7629140.0.0.karFPe&treeId=257&articleId=105735&docType=1
            strategy: # 通知策略
                minIntervalSec: 0 # 最小间隔的通知时间，0表示不设置，如为10则表示10s内只会发送一次
                dndTime: # 免扰时间，HH:mm-HH:mm 如，18:00-06:00
                forceSendTimes: 3 # 同一免扰周期间通知调用达到几次后强制发送
    security: # 安全功能
        cors:
            allow-origin: * # 允许的来源，建议修改
            allow-methods: POST,GET,OPTIONS,PUT,DELETE,HEAD # 允许的方法
            allow-headers: x-requested-with,content-type # 允许的头信息
        token-flag: __dew_token__ # token 标识
        token-in-header: true # true：token标识在 header 中，反之在url参数中
        token-hash: false # token值是否需要hash，用于解决token值有特殊字符的情况
        include-services: [""] # 服务白名单，要求源服务头部带上 Request-From
        exclude-services: [""] # 服务黑名单，要求源服务头部带上 Request-From
    component:
        auth:
          token-expire-sec: 60 * 60 * 24 * 30 # token有效期，默认为30天
          max-login-error-times: 3 # 最大登录错误次数，默认3次
          clean-error-time-min: 10 # 登录错误限制登录时间，默认为10分钟
          password-salt: # 密码加盐
          email-account: # 发通知邮件的邮箱账号，比如用来发送用户注册成功邮件
          sdk:
              server-url: # 服务器地址
              white-list: # 白名单，逗号分隔
    cloud:
        trace-log:
            enabled: true # 是否启用服务API调用（追踪）日志，默认为true
        error:
             enabled: true # 启用降级邮件通知，默认为false
             notify-flag: __HYSTRIX__ # 默认的通知标识
             notify-event-types: FAILURE,SHORT_CIRCUITED,TIMEOUT,THREAD_POOL_REJECTED,SEMAPHORE_REJECTED # 通知的事件类型
             notify-include-keys: # 需监控的方法key值，与notify-exclude-keys互斥，client类名+#+方法名，for example:  ExampleClient#deleteExe(int,String)
             notify-exclude-keys: # 不需要监控的方法key值，与notify-include-keys互斥，client类名+#+方法名，for example:  ExampleClient#deleteExe(int,String)
    idempotent:
        default-expire-ms: 3600000 # 设置默认过期时间，1小时
        default-strategy: item # 设置默认策略，目前支持item(逐条记录)
        default-opt-id-flag: __IDEMPOTENT_OPT_ID__ # 指定幂等操作ID标识，可以位于HTTP Header或请求参数中

spring:
    application:
         name:  # 项目名称,若使用Dew，请配置
    mail: #mail配置，需要hystrix降级通知需加以下配置
         host: smtp.163.com
         username:
         password:
         properties:
           mail:
             smtp:
               auth: true
                 starttls:
                   enable: true
                   required: true
    hazelcast: # hazelcast相关配置
         username:
         password:
         addresses: ["127.0.0.1"]
         connection-timeout: #默认5000
         connection-attempt-limit: #默认2
         connection-attempt-period: #默认3000