Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 3.35 KB

README.md

File metadata and controls

47 lines (38 loc) · 3.35 KB
Raw

Kafka消息推送插件

插件功能

将请求和响应转发到kafka消息服务

功能特性

  • 本插件基于reactor-kafka
  • 可通过application.yml或者fizz网关管理后台配置
  • 插件优先使用fizz网关管理后台配置,fizz网关管理后台配置项会覆盖application.yml中的配置项
  • 配置参数与springboot中KafkaAutoConfiguration中使用到KafkaProperties保持一致
  • 路由设置维度的配置参数调整会在10分钟后生效
  • 推送到kafka的消息内容包括requestId, method, headers,path, ip, cookies, body, response body等

插件配置

使用本插件需要通过以下参数配置kafka服务地址和topic名称(application.yml,Fizz管理后台插件配置或者路由配置中设置),其他配置项可参考KafkaProperties类中定义的相关属性。

  • spring.kafka.bootstrap-servers
  • fizz-plugin-kafka-topic

插件使用

  1. gateway项目pom文件中引入以下依赖 
        <dependency>
    <groupId>com.fizzgate</groupId>
        <artifactId>fizz-plugin-kafka</artifactId>
        <version>2.7.1</version>
        <exclusions>
            <exclusion>
           <groupId>com.fizzgate</groupId>
 		   <artifactId>fizz-spring-boot-starter</artifactId> 
            </exclusion>
        </exclusions>
    </dependency>
  2. 管理后台导入以下SQL 
        INSERT INTO `tb_plugin` (`fixed_config`, `eng_name`, `chn_name`, `config`, `order`, `instruction`, `type`, `create_user`, `create_dept`, `create_time`, `update_user`, `update_time`, `status`, `is_deleted`) VALUES ('', 'kafkaMessagePlugin', 'Kafka消息推送插件', '[{"field":"blockSourceRequest","label":"阻断原请求","component":"select","dataType":"string","value":"false","options":[{"label":"是","value":"true"},{"label":"否","value":"false"}],"desc":"选择是否需要阻断原来的请求，选择是的话，请求将不会被转发，而是只将请求转化为消息并投递到消息中间件中","placeholder":"请选择","rules":[{"required":true,"message":"请选择是否阻断原请求","trigger":"change"}]},{"field":"addresses","label":"Kafka服务地址","component":"input","dataType":"string","desc":"Kafka服务器地址及端口，如有多个，中间以英文逗号隔开; 如：172.25.12.101:9092","placeholder":"请输入地址","rules":[{"required":true,"message":"服务地址不能为空","trigger":"change"}]},{"field":"topic","label":"目标Topic","component":"input","dataType":"string","desc":"发送的目标Topic","placeholder":"请输入地址","rules":[{"required":true,"message":"目标topic不能为空","trigger":"change"}]},{"field":"respJson","label":"响应JSON","component":"input","dataType":"string","desc":"阻断原请求时的响应JSON，如：{\\"code\\": 0, \\"message\\":\\"success\\"}，如果不填则响应空","placeholder":"响应JSON","rules":[{"required":false,"trigger":"change"}]}]', 255, '', 2, 1123598821738675201, 1260823335286165505, '2021-10-15 15:22:48', 1123598821738675201, '2022-10-26 15:14:57', 1, 0);
  3. 在Fizz网关路由配置中选择使用本插件，并配置好kafka服务地址和Topic
  4. 请求返回后插件会将推送结果回写到响应头中, fizz-plugin-kafka-result写回推送结果，1表示推送成功, 0表示推送失败;如果推送成功,插件通过fizz-plugin-kafka-metadata回写kafka metadata信息