├── src └── main │ ├── resources │ └── META-INF │ │ ├── spring.provides │ │ └── spring.factories │ └── java │ └── com │ └── maihaoche │ └── starter │ └── mq │ ├── MQException.java │ ├── annotation │ ├── EnableMQConfiguration.java │ ├── MQKey.java │ ├── MQProducer.java │ └── MQConsumer.java │ ├── config │ ├── MQProperties.java │ ├── MQBaseAutoConfiguration.java │ ├── MQProducerAutoConfiguration.java │ └── MQConsumerAutoConfiguration.java │ └── base │ ├── AbstractMQPushConsumer.java │ ├── AbstractMQConsumer.java │ ├── AbstractMQPullConsumer.java │ └── AbstractMQProducer.java ├── .gitignore ├── pom.xml ├── README.md └── LICENSE /src/main/resources/META-INF/spring.provides: -------------------------------------------------------------------------------- 1 | provides: rocketmq-spring-boot-starter -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring.factories: -------------------------------------------------------------------------------- 1 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ 2 | com.maihaoche.starter.mq.config.MQBaseAutoConfiguration,\ 3 | com.maihaoche.starter.mq.config.MQConsumerAutoConfiguration,\ 4 | com.maihaoche.starter.mq.config.MQProducerAutoConfiguration -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/MQException.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq; 2 | 3 | /** 4 | * Created by yipin on 2017/6/28. 5 | * RocketMQ的自定义异常 6 | */ 7 | public class MQException extends RuntimeException { 8 | public MQException(String msg) { 9 | super(msg); 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | !.mvn/wrapper/maven-wrapper.jar 3 | 4 | ### STS ### 5 | .apt_generated 6 | .classpath 7 | .factorypath 8 | .project 9 | .settings 10 | .springBeans 11 | 12 | ### IntelliJ IDEA ### 13 | .idea 14 | *.iws 15 | *.iml 16 | *.ipr 17 | 18 | ### NetBeans ### 19 | nbproject/private/ 20 | build/ 21 | nbbuild/ 22 | nbdist/ 23 | .nb-gradle/ -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/annotation/EnableMQConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.annotation; 2 | 3 | import java.lang.annotation.*; 4 | 5 | /** 6 | * Created by suclogger on 2017/6/30. 7 | */ 8 | @Target(ElementType.TYPE) 9 | @Retention(RetentionPolicy.RUNTIME) 10 | @Documented 11 | @Inherited 12 | public @interface EnableMQConfiguration { 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/annotation/MQKey.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.annotation; 2 | 3 | import java.lang.annotation.*; 4 | 5 | /** 6 | * 7 | * 用来标识作为消息key的字段 8 | * prefix 会作为前缀拼到字段值前面 9 | * 10 | * @since 0.0.4 11 | * @author suclogger 12 | * 13 | */ 14 | @Target(ElementType.FIELD) 15 | @Retention(RetentionPolicy.RUNTIME) 16 | @Documented 17 | public @interface MQKey { 18 | String prefix() default ""; 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/config/MQProperties.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.config; 2 | 3 | import lombok.Data; 4 | import org.springframework.boot.context.properties.ConfigurationProperties; 5 | 6 | /** 7 | * Created by yipin on 2017/6/28. 8 | * RocketMQ的配置参数 9 | */ 10 | @Data 11 | @ConfigurationProperties(prefix = "rocketmq") 12 | public class MQProperties { 13 | private String nameServerAddress; 14 | private String producerGroup; 15 | } 16 | -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/annotation/MQProducer.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.annotation; 2 | 3 | import org.springframework.stereotype.Component; 4 | 5 | import java.lang.annotation.*; 6 | 7 | /** 8 | * Created by yipin on 2017/6/27. 9 | * RocketMQ生产者自动装配注解 10 | */ 11 | @Target(ElementType.TYPE) 12 | @Retention(RetentionPolicy.RUNTIME) 13 | @Documented 14 | @Component 15 | public @interface MQProducer { 16 | String topic() default ""; 17 | String tag() default ""; 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/annotation/MQConsumer.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.annotation; 2 | 3 | import org.springframework.stereotype.Component; 4 | 5 | import java.lang.annotation.*; 6 | 7 | /** 8 | * Created by yipin on 2017/6/27. 9 | * RocketMQ消费者自动装配注解 10 | */ 11 | @Target(ElementType.TYPE) 12 | @Retention(RetentionPolicy.RUNTIME) 13 | @Documented 14 | @Component 15 | public @interface MQConsumer { 16 | String consumerGroup() default ""; 17 | String topic() default ""; 18 | String messageMode() default "CLUSTERING"; 19 | String consumeMode() default "CONCURRENTLY"; 20 | String[] tag() default {"*"}; 21 | } 22 | -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/config/MQBaseAutoConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.config; 2 | 3 | import com.maihaoche.starter.mq.annotation.EnableMQConfiguration; 4 | import com.maihaoche.starter.mq.base.AbstractMQProducer; 5 | import com.maihaoche.starter.mq.base.AbstractMQPushConsumer; 6 | import org.springframework.beans.BeansException; 7 | import org.springframework.beans.factory.annotation.Autowired; 8 | import org.springframework.boot.autoconfigure.AutoConfigureAfter; 9 | import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; 10 | import org.springframework.boot.context.properties.EnableConfigurationProperties; 11 | import org.springframework.context.ApplicationContext; 12 | import org.springframework.context.ApplicationContextAware; 13 | import org.springframework.context.annotation.Configuration; 14 | 15 | /** 16 | * Created by yipin on 2017/6/28. 17 | * RocketMQ配置文件 18 | */ 19 | @Configuration 20 | @ConditionalOnBean(annotation = EnableMQConfiguration.class) 21 | @AutoConfigureAfter({AbstractMQProducer.class, AbstractMQPushConsumer.class}) 22 | @EnableConfigurationProperties(MQProperties.class) 23 | public class MQBaseAutoConfiguration implements ApplicationContextAware { 24 | @Autowired 25 | protected MQProperties mqProperties; 26 | protected ApplicationContext applicationContext; 27 | 28 | @Override 29 | public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { 30 | this.applicationContext = applicationContext; 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/base/AbstractMQPushConsumer.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.base; 2 | 3 | import lombok.Getter; 4 | import lombok.Setter; 5 | import lombok.extern.slf4j.Slf4j; 6 | import org.apache.rocketmq.client.consumer.DefaultMQPushConsumer; 7 | import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyContext; 8 | import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus; 9 | import org.apache.rocketmq.client.consumer.listener.ConsumeOrderlyContext; 10 | import org.apache.rocketmq.client.consumer.listener.ConsumeOrderlyStatus; 11 | import org.apache.rocketmq.common.message.MessageExt; 12 | 13 | import java.util.List; 14 | 15 | /** 16 | * Created by yipin on 2017/6/27. 17 | * RocketMQ的消费者(Push模式)处理消息的接口 18 | */ 19 | @Slf4j 20 | public abstract class AbstractMQPushConsumer extends AbstractMQConsumer{ 21 | 22 | @Getter 23 | @Setter 24 | private DefaultMQPushConsumer consumer; 25 | 26 | public AbstractMQPushConsumer() { 27 | } 28 | 29 | /** 30 | * 原生dealMessage方法，可以重写此方法自定义序列化和返回消费成功的相关逻辑 31 | * 32 | * @param list 消息列表 33 | * @param consumeConcurrentlyContext 上下文 34 | * @return 消费状态 35 | */ 36 | public ConsumeConcurrentlyStatus dealMessage(List list, ConsumeConcurrentlyContext consumeConcurrentlyContext) { 37 | for(MessageExt messageExt : list) { 38 | if(messageExt.getReconsumeTimes() != 0) { 39 | if (checkReachMaxRetryTimes(messageExt)) { 40 | return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; 41 | } 42 | } 43 | log.info("receive msgId: {}, tags : {}" , messageExt.getMsgId(), messageExt.getTags()); 44 | T t = parseMessage(messageExt); 45 | if( null != t && !process( messageExt.getKeys(), messageExt.getTags(), t)) { 46 | log.warn("consume fail , ask for re-consume , msgId: {}", messageExt.getMsgId()); 47 | return ConsumeConcurrentlyStatus.RECONSUME_LATER; 48 | } 49 | } 50 | return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; 51 | } 52 | 53 | /** 54 | * 原生dealMessage方法，可以重写此方法自定义序列化和返回消费成功的相关逻辑 55 | * 56 | * @param list 消息列表 57 | * @param consumeOrderlyContext 上下文 58 | * @return 处理结果 59 | */ 60 | public ConsumeOrderlyStatus dealMessage(List list, ConsumeOrderlyContext consumeOrderlyContext) { 61 | for(MessageExt messageExt : list) { 62 | if(messageExt.getReconsumeTimes() != 0) { 63 | if (checkReachMaxRetryTimes(messageExt)) { 64 | return ConsumeOrderlyStatus.SUCCESS; 65 | } 66 | } 67 | log.info("receive msgId: {}, tags : {}" , messageExt.getMsgId(), messageExt.getTags()); 68 | T t = parseMessage(messageExt); 69 | if( null != t && !process(messageExt.getKeys(), messageExt.getTags(), t)) { 70 | log.warn("consume fail , ask for re-consume , msgId: {}", messageExt.getMsgId()); 71 | return ConsumeOrderlyStatus.SUSPEND_CURRENT_QUEUE_A_MOMENT; 72 | } 73 | } 74 | return ConsumeOrderlyStatus.SUCCESS; 75 | } 76 | 77 | 78 | } 79 | -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/base/AbstractMQConsumer.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.base; 2 | 3 | import com.google.gson.Gson; 4 | import com.google.gson.JsonSyntaxException; 5 | import java.io.UnsupportedEncodingException; 6 | import java.lang.reflect.ParameterizedType; 7 | import java.lang.reflect.Type; 8 | import lombok.extern.slf4j.Slf4j; 9 | import org.apache.rocketmq.common.message.MessageExt; 10 | import org.springframework.util.Assert; 11 | 12 | /** 13 | * Comments：RocketMQ消费抽象基类 14 | * Author：Jay Chang 15 | * Create Date：2017/9/14 16 | * Modified By： 17 | * Modified Date： 18 | * Why & What is modified： 19 | * Version：v1.0 20 | */ 21 | @Slf4j 22 | public abstract class AbstractMQConsumer { 23 | 24 | protected static Gson gson = new Gson(); 25 | /**默认最大重试次数5次*/ 26 | protected static final int MAX_RETRY_TIMES = 5; 27 | 28 | /** 29 | * 继承这个方法处理消息 30 | * 31 | * @param message 消息范型 32 | * @param messageKey 消息key 33 | * @param tag 消息tag 34 | * @return 处理结果 35 | */ 36 | public abstract boolean process(String messageKey,String tag, T message); 37 | 38 | /** 39 | * 反序列化解析消息 40 | * 41 | * @param message 消息体 42 | * @return 序列化结果 43 | */ 44 | protected T parseMessage(MessageExt message) { 45 | if (message == null || message.getBody() == null) { 46 | return null; 47 | } 48 | final Type type = this.getMessageType(); 49 | if (type instanceof Class) { 50 | String messageBody = null; 51 | try { 52 | T data = gson.fromJson(messageBody = new String(message.getBody(),"utf-8"), type); 53 | return data; 54 | } catch (JsonSyntaxException e) { 55 | log.error("parse message json fail : {},message body:{}", e.getMessage(),messageBody); 56 | } catch (UnsupportedEncodingException e) { 57 | log.error("parse message json fail : {},message content:{}", e.getMessage()); 58 | } 59 | } else { 60 | log.warn("Parse msg error. {}", message); 61 | } 62 | return null; 63 | } 64 | 65 | /** 66 | * 解析消息类型 67 | * 68 | * @return 消息类型 69 | */ 70 | protected Type getMessageType() { 71 | Type superType = this.getClass().getGenericSuperclass(); 72 | if (superType instanceof ParameterizedType) { 73 | ParameterizedType parameterizedType = (ParameterizedType) superType; 74 | Type[] actualTypeArguments = parameterizedType.getActualTypeArguments(); 75 | Assert.isTrue(actualTypeArguments.length == 1, "Number of type arguments must be 1"); 76 | return actualTypeArguments[0]; 77 | } else { 78 | // 如果没有定义泛型，解析为Object 79 | return Object.class; 80 | } 81 | } 82 | 83 | protected boolean checkReachMaxRetryTimes(MessageExt messageExt) { 84 | log.info("re-consume times: {}" , messageExt.getReconsumeTimes()); 85 | //大于最大重试次数则记录失败日志，并返回ConsumeOrderlyStatus.SUCCESS 86 | if(messageExt.getReconsumeTimes() >= MAX_RETRY_TIMES){ 87 | log.error("Consumer reach the maximum number of retries,please process by manual work,msgId:{},msgKey:{},tags:{}",messageExt.getMsgId(),messageExt.getKeys(),messageExt.getTags()); 88 | return true; 89 | } 90 | return false; 91 | } 92 | } 93 | -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/base/AbstractMQPullConsumer.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.base; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | import org.apache.rocketmq.client.consumer.DefaultMQPullConsumer; 5 | import org.apache.rocketmq.client.consumer.PullResult; 6 | import org.apache.rocketmq.common.message.MessageExt; 7 | import org.apache.rocketmq.common.message.MessageQueue; 8 | 9 | import java.util.List; 10 | import java.util.Set; 11 | 12 | /** 13 | * Created by yipin on 2017/6/27. 14 | * RocketMQ的消费者(Push模式)处理消息的接口 15 | */ 16 | @Slf4j 17 | public abstract class AbstractMQPullConsumer extends AbstractMQConsumer{ 18 | 19 | public AbstractMQPullConsumer() { 20 | } 21 | 22 | private String topic; 23 | 24 | private DefaultMQPullConsumer consumer; 25 | 26 | public DefaultMQPullConsumer getConsumer() { 27 | return consumer; 28 | } 29 | 30 | public void setTopic(String topic) { 31 | this.topic = topic; 32 | } 33 | 34 | public void setConsumer(DefaultMQPullConsumer consumer) { 35 | this.consumer = consumer; 36 | } 37 | 38 | public void startInner() { 39 | new Thread(() -> { 40 | try { 41 | while(true) { 42 | Set mqs = consumer.fetchMessageQueuesInBalance(topic); 43 | try { 44 | for (MessageQueue mq : mqs) { 45 | SINGLE_MQ: 46 | while (true) { 47 | try {//阻塞的拉去消息，中止时间默认20s 48 | long offset = consumer.fetchConsumeOffset(mq, false); 49 | offset = offset < 0 ? 0 : offset; 50 | PullResult pullResult = consumer.pull(mq, null, offset, 10); 51 | switch (pullResult.getPullStatus()) { 52 | case FOUND://pullSataus 53 | dealMessage(pullResult.getMsgFoundList()); 54 | break; 55 | case NO_MATCHED_MSG: 56 | break; 57 | case NO_NEW_MSG: 58 | break SINGLE_MQ; 59 | case OFFSET_ILLEGAL: 60 | break; 61 | default: 62 | break; 63 | } 64 | consumer.updateConsumeOffset(mq, pullResult.getNextBeginOffset()); 65 | } catch (Exception e) { 66 | log.error("consume message fail , e : {}", e); 67 | } 68 | } 69 | } 70 | } catch (Exception e) { 71 | log.error("start pull consumer fail, e : {}", e.getMessage()); 72 | } 73 | } 74 | } catch (Exception e) { 75 | log.error("start pull consumer fail, e : {}", e.getMessage()); 76 | } 77 | }).start(); 78 | } 79 | 80 | /** 81 | * 原生dealMessage方法，可以重写此方法自定义序列化和返回消费成功的相关逻辑 82 | * 83 | * @param list 消息列表 84 | */ 85 | public void dealMessage(List list) { 86 | for(MessageExt messageExt : list) { 87 | if(messageExt.getReconsumeTimes() != 0) { 88 | //达到最大重试次数则不对消息进行消费 89 | if(checkReachMaxRetryTimes(messageExt)){ 90 | continue; 91 | } 92 | } 93 | log.info("receive msgId: {}, tags : {}" , messageExt.getMsgId(), messageExt.getTags()); 94 | T t = parseMessage(messageExt); 95 | process(messageExt.getKeys(),messageExt.getTags(),t); 96 | } 97 | } 98 | } 99 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 1.5.6.RELEASE 9 | 10 | 11 | 4.0.0 12 | 13 | 1.8 14 | 4.0.0-incubating 15 | UTF-8 16 | 17 | 18 | jar 19 | spring-boot-starter-rocketmq 20 | spring boot starter for rocketmq 21 | 22 | com.maihaoche 23 | spring-boot-starter-rocketmq 24 | qh-1.0.0 25 | 26 | 27 | 28 | releases 29 | local private nexus 30 | http://192.168.59.240:8081/repository/maven-releases/ 31 | 32 | 33 | snapshots 34 | local private nexus 35 | http://192.168.59.240:8081/repository/maven-snapshots/ 36 | 37 | 38 | 39 | 40 | 41 | org.springframework.boot 42 | spring-boot-starter 43 | 44 | 45 | org.projectlombok 46 | lombok 47 | 48 | 49 | com.google.code.gson 50 | gson 51 | 52 | 53 | org.apache.rocketmq 54 | rocketmq-client 55 | ${rocketmq.version} 56 | 57 | 58 | org.springframework.boot 59 | spring-boot-configuration-processor 60 | true 61 | 62 | 63 | 64 | 65 | release-to-oss 66 | 67 | 68 | 69 | 70 | org.apache.maven.plugins 71 | maven-source-plugin 72 | 73 | 74 | package 75 | 76 | jar-no-fork 77 | 78 | 79 | 80 | 81 | 82 | 83 | org.apache.maven.plugins 84 | maven-javadoc-plugin 85 | 86 | 87 | package 88 | 89 | jar 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/config/MQProducerAutoConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.config; 2 | 3 | import com.maihaoche.starter.mq.annotation.MQProducer; 4 | import com.maihaoche.starter.mq.base.AbstractMQProducer; 5 | import java.lang.reflect.Field; 6 | import lombok.extern.slf4j.Slf4j; 7 | import org.apache.commons.lang3.StringUtils; 8 | import org.apache.commons.lang3.reflect.FieldUtils; 9 | import org.apache.rocketmq.client.producer.DefaultMQProducer; 10 | import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; 11 | import org.springframework.context.annotation.Configuration; 12 | 13 | import javax.annotation.PostConstruct; 14 | import java.util.Map; 15 | import org.springframework.util.CollectionUtils; 16 | 17 | /** 18 | * Created by yipin on 2017/6/29. 19 | * 自动装配消息生产者 20 | */ 21 | @Slf4j 22 | @Configuration 23 | @ConditionalOnBean(MQBaseAutoConfiguration.class) 24 | public class MQProducerAutoConfiguration extends MQBaseAutoConfiguration { 25 | 26 | private DefaultMQProducer producer; 27 | 28 | @PostConstruct 29 | public void init() throws Exception { 30 | Map beans = applicationContext.getBeansWithAnnotation(MQProducer.class); 31 | //对于仅仅存在消费者的项目，无需初始化producer实例 32 | if(CollectionUtils.isEmpty(beans)){ 33 | return; 34 | } 35 | if(producer == null) { 36 | if(StringUtils.isEmpty(mqProperties.getProducerGroup())) { 37 | throw new RuntimeException("producer group must be defined"); 38 | } 39 | if(StringUtils.isEmpty(mqProperties.getNameServerAddress())) { 40 | throw new RuntimeException("name server address must be defined"); 41 | } 42 | producer = new DefaultMQProducer(mqProperties.getProducerGroup()); 43 | producer.setNamesrvAddr(mqProperties.getNameServerAddress()); 44 | producer.start(); 45 | } 46 | for (Map.Entry entry : beans.entrySet()) { 47 | publishProducer(entry.getKey(), entry.getValue()); 48 | } 49 | } 50 | 51 | private void publishProducer(String beanName, Object bean) throws Exception { 52 | if(!AbstractMQProducer.class.isAssignableFrom(bean.getClass())) { 53 | throw new RuntimeException(beanName + " - producer未继承AbstractMQProducer"); 54 | } 55 | AbstractMQProducer abstractMQProducer = (AbstractMQProducer) bean; 56 | abstractMQProducer.setProducer(producer); 57 | // begin build producer level topic 58 | MQProducer mqProducer = applicationContext.findAnnotationOnBean(beanName, MQProducer.class); 59 | 60 | //优先使用MQProducer注解指定的topic值 61 | String topic = mqProducer.topic(); 62 | 63 | if(StringUtils.isEmpty(topic)) { 64 | //其次使用生产者实例的topic字段值 65 | final Field topicField = FieldUtils.getDeclaredField(bean.getClass(),"topic",true); 66 | if(null != topicField){ 67 | Object topicFieldValue = topicField.get(bean); 68 | if(null == topicFieldValue){ 69 | throw new RuntimeException("producer's topic field should set a value"); 70 | } 71 | if(!String.class.isAssignableFrom(topicField.getType())){ 72 | throw new RuntimeException("producer's field which named topic must be String"); 73 | } 74 | topic = (String)topicFieldValue; 75 | } 76 | } 77 | //如果环境变量有设置，则使用环境变量，但环境变量的key取决于@MQProducer的topic值或生产者的topic字段值 78 | if(StringUtils.isNotEmpty(topic)) { 79 | // 取topic环境变量 80 | String topicEnv = applicationContext.getEnvironment().getProperty(topic); 81 | topic = StringUtils.isEmpty(topicEnv) ? topic : topicEnv; 82 | } 83 | abstractMQProducer.setTopic(topic); 84 | // begin build producer level tag 85 | String tag = mqProducer.tag(); 86 | if(StringUtils.isNotEmpty(tag)) { 87 | String transTag = applicationContext.getEnvironment().getProperty(tag); 88 | tag = StringUtils.isEmpty(transTag) ? tag : transTag; 89 | } 90 | abstractMQProducer.setTag(tag); 91 | log.info(String.format("%s is ready to produce message", beanName)); 92 | } 93 | } -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/config/MQConsumerAutoConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.config; 2 | 3 | import com.maihaoche.starter.mq.annotation.MQConsumer; 4 | import com.maihaoche.starter.mq.base.AbstractMQConsumer; 5 | import com.maihaoche.starter.mq.base.AbstractMQPullConsumer; 6 | import com.maihaoche.starter.mq.base.AbstractMQPushConsumer; 7 | import java.lang.reflect.Field; 8 | import lombok.extern.slf4j.Slf4j; 9 | import org.apache.commons.lang3.StringUtils; 10 | import org.apache.commons.lang3.reflect.FieldUtils; 11 | import org.apache.rocketmq.client.consumer.DefaultMQPullConsumer; 12 | import org.apache.rocketmq.client.consumer.DefaultMQPushConsumer; 13 | import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyContext; 14 | import org.apache.rocketmq.client.consumer.listener.ConsumeOrderlyContext; 15 | import org.apache.rocketmq.common.message.MessageExt; 16 | import org.apache.rocketmq.common.protocol.heartbeat.MessageModel; 17 | import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; 18 | import org.springframework.context.annotation.Configuration; 19 | 20 | import javax.annotation.PostConstruct; 21 | import java.util.List; 22 | import java.util.Map; 23 | import java.util.UUID; 24 | 25 | /** 26 | * Created by suclogger on 2017/6/28. 27 | * 自动装配消息消费者 28 | */ 29 | @Slf4j 30 | @Configuration 31 | @ConditionalOnBean(MQBaseAutoConfiguration.class) 32 | public class MQConsumerAutoConfiguration extends MQBaseAutoConfiguration { 33 | @PostConstruct 34 | public void init() throws Exception { 35 | Map beans = applicationContext.getBeansWithAnnotation(MQConsumer.class); 36 | for (Map.Entry entry : beans.entrySet()) { 37 | publishConsumer(entry.getKey(), entry.getValue()); 38 | } 39 | } 40 | 41 | private void publishConsumer(String beanName, Object bean) throws Exception { 42 | MQConsumer mqConsumer = applicationContext.findAnnotationOnBean(beanName, MQConsumer.class); 43 | if(StringUtils.isEmpty(mqProperties.getNameServerAddress())) { 44 | throw new RuntimeException("name server address must be defined"); 45 | } 46 | final Field consumerGroupField = FieldUtils.getDeclaredField(bean.getClass(), "consumerGroup", true); 47 | //优先使用@MQConsumer注解定义的consumerGroup值 48 | String consumerGroup = mqConsumer.consumerGroup(); 49 | if(StringUtils.isEmpty(consumerGroup)) { 50 | //再次使用AbstractMQPullConsumer,AbstractMQPushConsumer子类实例的consumerGroup字段值 51 | if(null == consumerGroupField){ 52 | throw new RuntimeException("consumer's consumerGroup not defined in @MQConsumer(use consumerGroup) annotation or not defined field which named consumerGroup(e.g. use ${\"rocketmq.demoConsumer.consumerGroup\"})"); 53 | } 54 | Object consumerGroupFieldValue = consumerGroupField.get(bean); 55 | if(null == consumerGroupFieldValue){ 56 | throw new RuntimeException("consumer's consumerGroup field should set a value"); 57 | } 58 | if(!String.class.isAssignableFrom(consumerGroupField.getType())){ 59 | throw new RuntimeException("consumer's field which named consumerGroup must be String"); 60 | } 61 | consumerGroup = (String)consumerGroupFieldValue; 62 | } 63 | final Field topicField = FieldUtils.getDeclaredField(bean.getClass(), "topic", true); 64 | //优先使用@MQConsumer注解定义的topic值 65 | String topic = mqConsumer.topic(); 66 | if(StringUtils.isEmpty(topic)) { 67 | //再次使用AbstractMQPullConsumer,AbstractMQPushConsumer子类实例的consumerGroup字段值 68 | if(null == topicField){ 69 | throw new RuntimeException("consumer's topic not defined in @MQConsumer(use topic) annotation or not defined field which named topic(e.g. use ${\"rocketmq.demoConsumer.topic\"})"); 70 | } 71 | Object topicFieldValue = topicField.get(bean); 72 | if(null == topicFieldValue){ 73 | throw new RuntimeException("consumer's topic field should set a value"); 74 | } 75 | if(!String.class.isAssignableFrom(topicField.getType())){ 76 | throw new RuntimeException("consumer's field which named topic must be String"); 77 | } 78 | topic = (String)topicFieldValue; 79 | } 80 | if(!AbstractMQPushConsumer.class.isAssignableFrom(bean.getClass()) 81 | && !AbstractMQPullConsumer.class.isAssignableFrom(bean.getClass())) { 82 | throw new RuntimeException(bean.getClass().getName() + " - consumer未实现AbstractMQPushConsumer或AbstractMQPullConsumer抽象类"); 83 | } 84 | //环境变量有对consumerGroup的配置，则取环境变量的配置（环境变量的key为@MQConsumer的consumerGroup或消费者实例consumerGroup字段的值，注意不是字段的名称） 85 | String consumerGroupEnv = applicationContext.getEnvironment().getProperty(consumerGroup); 86 | if(StringUtils.isNotEmpty(consumerGroupEnv)) { 87 | consumerGroup = consumerGroupEnv; 88 | } 89 | //环境变量有对topic的配置，则取环境变量的配置（环境变量的key为@MQConsumer的topic或消费者实例topic字段的值，注意不是字段的名称） 90 | String topicEnv = applicationContext.getEnvironment().getProperty(topic); 91 | if(StringUtils.isNotEmpty(topicEnv)) { 92 | topic = topicEnv; 93 | } 94 | // 配置push consumer 95 | if(AbstractMQPushConsumer.class.isAssignableFrom(bean.getClass())) { 96 | DefaultMQPushConsumer consumer = new DefaultMQPushConsumer(consumerGroup); 97 | consumer.setNamesrvAddr(mqProperties.getNameServerAddress()); 98 | consumer.setMessageModel(MessageModel.valueOf(mqConsumer.messageMode())); 99 | consumer.subscribe(topic, StringUtils.join(mqConsumer.tag(),"||")); 100 | consumer.setInstanceName(UUID.randomUUID().toString()); 101 | AbstractMQPushConsumer abstractMQPushConsumer = (AbstractMQPushConsumer) bean; 102 | if(mqConsumer.consumeMode().equals("CONCURRENTLY")) { 103 | consumer.registerMessageListener((List list, ConsumeConcurrentlyContext consumeConcurrentlyContext) -> 104 | abstractMQPushConsumer.dealMessage(list, consumeConcurrentlyContext)); 105 | } else if(mqConsumer.consumeMode().equals("ORDERLY")) { 106 | consumer.registerMessageListener((List list, ConsumeOrderlyContext consumeOrderlyContext) -> 107 | abstractMQPushConsumer.dealMessage(list, consumeOrderlyContext)); 108 | } else { 109 | throw new RuntimeException("unknown consume mode ! only support CONCURRENTLY and ORDERLY"); 110 | } 111 | abstractMQPushConsumer.setConsumer(consumer); 112 | consumer.start(); 113 | } else if (AbstractMQPullConsumer.class.isAssignableFrom(bean.getClass())) { 114 | 115 | // 配置pull consumer 116 | 117 | AbstractMQPullConsumer abstractMQPullConsumer = AbstractMQPullConsumer.class.cast(bean); 118 | 119 | DefaultMQPullConsumer consumer = new DefaultMQPullConsumer(consumerGroup); 120 | consumer.setNamesrvAddr(mqProperties.getNameServerAddress()); 121 | consumer.setMessageModel(MessageModel.valueOf(mqConsumer.messageMode())); 122 | consumer.setInstanceName(UUID.randomUUID().toString()); 123 | consumer.start(); 124 | 125 | abstractMQPullConsumer.setTopic(topic); 126 | abstractMQPullConsumer.setConsumer(consumer); 127 | abstractMQPullConsumer.startInner(); 128 | } 129 | 130 | log.info(String.format("%s is ready to subscribe message", bean.getClass().getName())); 131 | } 132 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # RocketMQ快速上手 2 | 3 | @(RocketMQ)[rocketmq-spring-boot-starter] 4 | 5 | 6 | ## 消费模式 7 | - **集群消费CLUSTERING**：一个Consumer Group中的各个Consumer实例分摊去消费消息，即一条消息只会投递到一个Consumer Group下面的一个实例，每个Consumer是平均分摊Message Queue的去做拉取消费。 8 | - **广播消费BROADCASTING**：消息将对一个Consumer Group下的各个Consumer实例都投递一遍。即即使这些 Consumer 属于同一个Consumer Group，消息也会被Consumer Group 中的每个Consumer都消费一次，一个消费组下的每个消费者实例都获取到了topic下面的每个Message Queue去拉取消费。 9 | 10 | ## 消息发送模式 11 | 12 | - **同步阻塞**：消息到达broker之后才返回，对应synSend。 13 | - **异步回调**：消息发送结束后触发回调，对应asynSend。 14 | - **发送即忘**：只管发送，不管是否到达broker，对应sendOneWay。 15 | 16 | ## 准备工作 17 | 18 | - **创建Topic**: 可以在RocketMQ 运维管理平台上创建，这里不详细赘述 19 | 20 | 21 | ## 快速体验消息生产、消费 22 | 23 | - **pom中引入rocketmq-spring-boot-starter依赖**: 24 | 这里针对我们公司的实际情况（环境比较多，不可能每个环境都部署一套rocketmq服务）做了一些定制： 25 | 可以在配置文件中配置消息生产者的topic，配置消息消费者的consumerGroup，topic。 26 | 一般一个应用只需要一个生产者 27 | 28 | ```xml 29 | 30 | com.maihaoche 31 | spring-boot-starter-rocketmq 32 | qh-1.0.0 33 | 34 | ``` 35 | 36 | - **application.yml里增加rocketmq配置**: 37 | 如果只有消费者只需要配置name-server-address，多个nameserv地址逗号分隔 38 | 如果项目中只有消费者，不需要生产者，则不需要配置producer-group 39 | ```xml 40 | rocketmq: 41 | name-server-address: 192.168.59.244:9876 42 | producer-group: PID_DEMO 43 | ``` 44 | 45 | - **在springboot应用主入口添加@EnableMQConfiguration注解开启自动装配**: 46 | ```java 47 | @EnableMQConfiguration 48 | @SpringBootApplication 49 | public class RmqDemoApplication { 50 | public static void main(String[] args) throws InterruptedException { 51 | SpringApplication.run(RmqDemoApplication.class, args); 52 | } 53 | } 54 | ``` 55 | 56 | - **创建消息生产者**: 57 | ```java 58 | @Slf4j 59 | //定义生产者默认将消息投放到哪个Topic，以及定义默认的tag(一般用于区分同一个业务，如订单业务对于业务订单状态变更时刻，会产生不同的消息类型，如订单创建、订单关闭、订单付款、订单发货) 60 | @MQProducer(topic = "TP_DEMO",tag = "A") 61 | public class DemoProducer extends AbstractMQProducer{ 62 | 63 | } 64 | ``` 65 | 如果想要将topic配置在配置文件中 66 | ```java 67 | @Slf4j 68 | @MQProducer 69 | public class DemoProducer extends AbstractMQProducer{ 70 | 71 | @Value("${rocketmq.demoProducer.topic}") 72 | private String topic; 73 | 74 | } 75 | ``` 76 | 其中@Value("${rocketmq.demoProducer.topic}")对应application.yml里的如下配置： 77 | ```yaml 78 | rocketmq: 79 | ... 80 | demoProducer: 81 | topic: TP_DEMO 82 | ``` 83 | 84 | 85 | 发送消息 86 | ```java 87 | //注入消息生产者 88 | @Autowired 89 | private DemoProducer demoProducer; 90 | 91 | for(int i = 0 ; i < 10 ; i++) { 92 | Demo demo = new Demo("jaychang"+i, "using rocketmq "+i); 93 | //若不填topic参数，则默认使用DemoProducer注解@MQProducer的topic值 94 | demoProducer.synSend("A",demo); 95 | //demoProducer.synSend("TP_DEMO", "A", demo); 96 | } 97 | ``` 98 | 99 | 100 | 101 | - **创建消息消费者**: 102 | 103 | ```java 104 | @MQConsumer(consumerGroup = "CONSUMER_DEMO_A",topic = "TP_DEMO",tag = "A") 105 | public class DemoConsumerA extends AbstractMQPushConsumer{ 106 | @Override 107 | public boolean processWithKey(String messageKey, Demo message) { 108 | System.out.println("DemoConsumerA.processWithKey "+"messageKey=【"+messageKey+"】,message=【"+message+"】"); 109 | return true; 110 | } 111 | } 112 | ``` 113 | 114 | 如果想要在配置文件中配置消息消费者的topic及consumerGroup可以按照以下写法： 115 | ``` 116 | @MQConsumer(tag = "A") 117 | public class DemoConsumerA extends AbstractMQPushConsumer{ 118 | 119 | @Value("${rocketmq.demoConsumerA.topic}") 120 | private String topic; 121 | 122 | @Value("${rocketmq.demoConsumerA.consumerGroup}") 123 | private String consumerGroup; 124 | 125 | @Override 126 | public boolean processWithKey(String messageKey, Demo message) { 127 | System.out.println("DemoConsumerA.processWithKey "+"messageKey=【"+messageKey+"】,message=【"+message+"】"); 128 | try { 129 | //模拟业务处理时间 130 | Thread.sleep(50); 131 | } catch (InterruptedException e) { 132 | e.printStackTrace(); 133 | } 134 | return true; 135 | } 136 | } 137 | ``` 138 | 其中@Value("${rocketmq.demoConsumerA.topic}")与@Value("${rocketmq.demoConsumerA.consumerGroup}")对应applicaiton.yml里的如下配置 139 | ```yaml 140 | rocketmq: 141 | ... 142 | 143 | demoConsumerA: 144 | topic: TP_DEMO 145 | consumerGroup: CONSUMER_DEMO_A 146 | ``` 147 | 148 | 149 | ## 无序、顺序消息 消费的注意点 150 | 151 | ### 无序 152 | 153 | 上述快速体验里已经有介绍了，默认不设置就是无需消息。 154 | 155 | ### 有序 156 | 有序消息需要生产者，消费者一起配合，生产者要保证每次消息都要投递到broker的同一个队列里，消费者需要设置 157 | 158 | 最简单的方式：创建Topic的时候只选择包含一个queue。 159 | 如果要增加吞吐量：发送消息的时候需要选择queue来实现部分有序，可以1个tag用1个queue。 160 | 161 | 见如下代码： 162 | ```java 163 | public class SelectMessageQueueByHash implements MessageQueueSelector { 164 | 165 | @Override 166 | public MessageQueue select(List mqs, Message msg, Object arg) { 167 | int value = arg.hashCode(); 168 | if (value < 0) { 169 | value = Math.abs(value); 170 | } 171 | 172 | value = value % mqs.size(); 173 | return mqs.get(value); 174 | } 175 | } 176 | ``` 177 | 最后一个用于MessageQueueSelector去筛选出，将消息投递到哪个queue，这里需要保证这个值是固定的， 178 | 可以根据新建Topic时候，确定有几个queue,来指定这个参数值，一般可以用"0" 179 | ```java 180 | Demo demo = new Demo("jaychang"+i, "using rocketmq "+i); 181 | 182 | demoProducer.synSendOrderly("TP_DEMO","O",demo,"0"); 183 | ``` 184 | 185 | 消息消费者需要配置consumeMode 为ORDERLY 186 | ```java 187 | @MQConsumer(consumerGroup = "CONSUMER_FOR_ORDERLY_DEMO",topic = "TP_DEMO",tag = "O",consumeMode = "ORDERLY") 188 | ``` 189 | 运行demo程序，http://127.0.0.1:8888/send31 190 | 191 | 观察控制台如下，可以发现消息是严格有序的 192 | 193 | ```java 194 | DemoForOrderlyConsumer1.processWithKey messageKey=【key_jaychang0】,message=【Demo(name=jaychang0, doSomething=using rocketmq 0)】 195 | 2017-09-15 16:53:37.558 INFO 15460 --- [MessageThread_1] c.m.s.mq.base.AbstractMQPushConsumer : receive msgId: C0A83B603C6418B4AAC24BB7FC190001, tags : O 196 | DemoForOrderlyConsumer1.processWithKey messageKey=【key_jaychang1】,message=【Demo(name=jaychang1, doSomething=using rocketmq 1)】 197 | 2017-09-15 16:53:37.608 INFO 15460 --- [MessageThread_1] c.m.s.mq.base.AbstractMQPushConsumer : receive msgId: C0A83B603C6418B4AAC24BB7FD8A0002, tags : O 198 | DemoForOrderlyConsumer1.processWithKey messageKey=【key_jaychang2】,message=【Demo(name=jaychang2, doSomething=using rocketmq 2)】 199 | 2017-09-15 16:53:37.659 INFO 15460 --- [MessageThread_1] c.m.s.mq.base.AbstractMQPushConsumer : receive msgId: C0A83B603C6418B4AAC24BB7FE3E0003, tags : O 200 | DemoForOrderlyConsumer1.processWithKey messageKey=【key_jaychang3】,message=【Demo(name=jaychang3, doSomething=using rocketmq 3)】 201 | 2017-09-15 16:53:37.709 INFO 15460 --- [MessageThread_1] c.m.s.mq.base.AbstractMQPushConsumer : receive msgId: C0A83B603C6418B4AAC24BB7FED20004, tags : O 202 | DemoForOrderlyConsumer1.processWithKey messageKey=【key_jaychang4】,message=【Demo(name=jaychang4, doSomething=using rocketmq 4)】 203 | 2017-09-15 16:53:37.759 INFO 15460 --- [MessageThread_1] c.m.s.mq.base.AbstractMQPushConsumer : receive msgId: C0A83B603C6418B4AAC24BB7FF690005, tags : O 204 | DemoForOrderlyConsumer1.processWithKey messageKey=【key_jaychang5】,message=【Demo(name=jaychang5, doSomething=using rocketmq 5)】 205 | 2017-09-15 16:53:37.810 INFO 15460 --- [MessageThread_1] c.m.s.mq.base.AbstractMQPushConsumer : receive msgId: C0A83B603C6418B4AAC24BB800030006, tags : O 206 | DemoForOrderlyConsumer1.processWithKey messageKey=【key_jaychang6】,message=【Demo(name=jaychang6, doSomething=using rocketmq 6)】 207 | 2017-09-15 16:53:37.860 INFO 15460 --- [MessageThread_1] c.m.s.mq.base.AbstractMQPushConsumer : receive msgId: C0A83B603C6418B4AAC24BB800A30007, tags : O 208 | DemoForOrderlyConsumer1.processWithKey messageKey=【key_jaychang7】,message=【Demo(name=jaychang7, doSomething=using rocketmq 7)】 209 | 2017-09-15 16:53:37.911 INFO 15460 --- [MessageThread_1] c.m.s.mq.base.AbstractMQPushConsumer : receive msgId: C0A83B603C6418B4AAC24BB801420008, tags : O 210 | DemoForOrderlyConsumer1.processWithKey messageKey=【key_jaychang8】,message=【Demo(name=jaychang8, doSomething=using rocketmq 8)】 211 | 2017-09-15 16:53:37.961 INFO 15460 --- [MessageThread_1] c.m.s.mq.base.AbstractMQPushConsumer : receive msgId: C0A83B603C6418B4AAC24BB801E20009, tags : O 212 | DemoForOrderlyConsumer1.processWithKey messageKey=【key_jaychang9】,message=【Demo(name=jaychang9, doSomething=using rocketmq 9)】 213 | ``` 214 | 215 | 这种方式可以保证消息绝对有序，但是性能还是有些损耗，故除非业务上有需要，不然就尽量不要使用顺序消息 216 | 217 | ## 集群、广播消费的注意点 218 | 219 | ## 集群消费 220 | 默认就是集群消费的模式即messageMode="CLUSTERING"，即同一消费组下，只能有一个消费实例收到消息 221 | 222 | ## 广播消费 223 | 若要使用广播消费模式,注意设置messageMode="BROADCASTING"，消费组有多个实例启动，那么这几个实例都会收到消息 224 | ```java 225 | @MQConsumer(consumerGroup = "CONSUMER_BROAD_CAST_DEMO",topic = "TP_DEMO",messageMode = "BROADCASTING",tag = "BRODCAST") 226 | ``` 227 | 228 | ## Demo地址 229 | 230 | Demo示例里包含了无序消息、顺序消息；集群消费（默认）、广播消费的例子 231 | http://git.sxb.lol/zhangjie/rmq-demo 232 | 233 | ## 开发环境RocketMQ Console 234 | 可以用于新建Topic，查询消息消费情况，查询消息内容，验证消费者等 235 | http://192.168.59.244:8080 236 | 237 | ## 建议的Topic、ProducerGroup,ConsumerGroup命名规范 238 | 239 | Demo里面关于Topic、ProducerGroup，ConsumerGroup的命名其实并不规范 240 | 241 | 这里参照阿里云ONS，定一些规范 242 | 243 | ### 前缀规范 244 | - **Topic前缀**: TP 245 | - **ProducerGroup前缀**:PID 246 | - **ConsumerGroup前缀**:CID 247 | 248 | ### 单词间用下划线隔开 249 | 250 | TP_COMPANY_INFO_SYNC 表示公司信息同步主题 251 | PID_COMPANY_INFO_SYNC 公司信息同步消息生产者组 252 | CID_COMPANY_INFO_SYNC 公司信息同步消息消费者组 253 | -------------------------------------------------------------------------------- /src/main/java/com/maihaoche/starter/mq/base/AbstractMQProducer.java: -------------------------------------------------------------------------------- 1 | package com.maihaoche.starter.mq.base; 2 | 3 | import com.google.gson.Gson; 4 | import com.maihaoche.starter.mq.MQException; 5 | import com.maihaoche.starter.mq.annotation.MQKey; 6 | import lombok.Getter; 7 | import lombok.Setter; 8 | import lombok.extern.slf4j.Slf4j; 9 | import org.apache.commons.lang3.StringUtils; 10 | import org.apache.rocketmq.client.producer.DefaultMQProducer; 11 | import org.apache.rocketmq.client.producer.MessageQueueSelector; 12 | import org.apache.rocketmq.client.producer.SendCallback; 13 | import org.apache.rocketmq.client.producer.SendResult; 14 | import org.apache.rocketmq.client.producer.selector.SelectMessageQueueByHash; 15 | import org.apache.rocketmq.common.message.Message; 16 | 17 | import javax.annotation.PreDestroy; 18 | import java.lang.annotation.Annotation; 19 | import java.lang.reflect.Field; 20 | import java.nio.charset.Charset; 21 | 22 | /** 23 | * Created by yipin on 2017/6/27. 24 | * RocketMQ的生产者的抽象基类 25 | */ 26 | @Slf4j 27 | public abstract class AbstractMQProducer { 28 | 29 | private static Gson gson = new Gson(); 30 | 31 | private MessageQueueSelector messageQueueSelector = new SelectMessageQueueByHash(); 32 | 33 | public AbstractMQProducer() { 34 | } 35 | 36 | private String tag; 37 | 38 | /** 39 | * 重写此方法,或者通过setter方法注入tag设置producer bean 级别的tag 40 | * 41 | * @return tag 42 | */ 43 | public String getTag() { 44 | return tag; 45 | } 46 | 47 | public void setTag(String tag) { 48 | this.tag = tag; 49 | } 50 | 51 | @Setter 52 | @Getter 53 | private DefaultMQProducer producer; 54 | 55 | @PreDestroy 56 | public void destroyProducer() { 57 | if (producer != null) { 58 | synchronized (AbstractMQProducer.class) { 59 | if (producer != null) { 60 | producer.shutdown(); 61 | } 62 | } 63 | } 64 | } 65 | 66 | private String topic; 67 | 68 | public void setTopic(String topic) { 69 | this.topic = topic; 70 | } 71 | 72 | /** 73 | * 重写此方法定义bean级别的topic，如果有返回有效topic，可以直接使用 sendMessage() 方法发送消息 74 | * 75 | * @return topic 76 | */ 77 | public String getTopic() { 78 | return this.topic; 79 | } 80 | 81 | private Message genMessage(String topic, String tag, Object msgObj) { 82 | String messageKey= ""; 83 | try { 84 | Field[] fields = msgObj.getClass().getDeclaredFields(); 85 | for (Field field : fields) { 86 | Annotation[] allFAnnos= field.getAnnotations(); 87 | if(allFAnnos.length > 0) { 88 | for (int i = 0; i < allFAnnos.length; i++) { 89 | if(allFAnnos[i].annotationType().equals(MQKey.class)) { 90 | field.setAccessible(true); 91 | MQKey mqKey = MQKey.class.cast(allFAnnos[i]); 92 | messageKey = StringUtils.isEmpty(mqKey.prefix()) ? field.get(msgObj).toString() : (mqKey.prefix() + field.get(msgObj).toString()); 93 | } 94 | } 95 | } 96 | } 97 | } catch (Exception e) { 98 | log.error("parse key error : {}" , e.getMessage()); 99 | } 100 | String str = gson.toJson(msgObj); 101 | if(StringUtils.isEmpty(topic)) { 102 | if(StringUtils.isEmpty(getTopic())) { 103 | throw new RuntimeException("no topic defined to send this message"); 104 | } 105 | topic = getTopic(); 106 | } 107 | Message message = new Message(topic, str.getBytes(Charset.forName("utf-8"))); 108 | if (!StringUtils.isEmpty(tag)) { 109 | message.setTags(tag); 110 | } else if (!StringUtils.isEmpty(getTag())) { 111 | message.setTags(getTag()); 112 | } 113 | if(StringUtils.isNotEmpty(messageKey)) { 114 | message.setKeys(messageKey); 115 | } 116 | return message; 117 | } 118 | 119 | 120 | /** 121 | * fire and forget 不关心消息是否送达，可以提高发送tps 122 | * 123 | * @param topic topic 124 | * @param tag tag 125 | * @param msgObj 消息体 126 | * @throws MQException 消息异常 127 | */ 128 | public void sendOneWay(String topic, String tag, Object msgObj) throws MQException { 129 | try { 130 | if(null == msgObj) { 131 | return; 132 | } 133 | producer.sendOneway(genMessage(topic, tag, msgObj)); 134 | log.info("send onway message success : {}", msgObj); 135 | } catch (Exception e) { 136 | log.error("消息发送失败，topic : {}, e {}", topic, e); 137 | throw new MQException("消息发送失败，topic :" + topic + ",e:" + e); 138 | } 139 | } 140 | 141 | /** 142 | * fire and forget 不关心消息是否送达，可以提高发送tps 143 | * 144 | * @param msgObj 消息体 145 | * @throws MQException 消息异常 146 | */ 147 | public void sendOneWay(Object msgObj) throws MQException { 148 | sendOneWay("", "", msgObj); 149 | } 150 | 151 | /** 152 | * fire and forget 不关心消息是否送达，可以提高发送tps 153 | * 154 | * @param tag tag 155 | * @param msgObj 消息体 156 | * @throws MQException 消息异常 157 | */ 158 | public void sendOneWay(String tag, Object msgObj) throws MQException { 159 | sendOneWay("", tag, msgObj); 160 | } 161 | 162 | 163 | /** 164 | * 可以保证同一个queue有序 165 | * 166 | * @param topic topic 167 | * @param tag tag 168 | * @param msgObj 消息体 169 | * @param hashKey 用于hash后选择queue的key 170 | */ 171 | public void sendOneWayOrderly(String topic, String tag, Object msgObj, String hashKey) { 172 | if(null == msgObj) { 173 | return; 174 | } 175 | if(StringUtils.isEmpty(hashKey)) { 176 | // fall back to normal 177 | sendOneWay(topic, tag, msgObj); 178 | } 179 | try { 180 | producer.sendOneway(genMessage(topic, tag, msgObj), messageQueueSelector, hashKey); 181 | log.info("send onway message orderly success : {}", msgObj); 182 | } catch (Exception e) { 183 | log.error("消息发送失败，topic : {}, msgObj {}", topic, msgObj); 184 | throw new MQException("顺序消息发送失败，topic :" + topic + ",e:" + e.getMessage()); 185 | } 186 | } 187 | 188 | /** 189 | * 同步发送消息 190 | * @param topic topic 191 | * @param tag tag 192 | * @param msgObj 消息体 193 | * @throws MQException 消息异常 194 | */ 195 | public void synSend(String topic, String tag, Object msgObj) throws MQException { 196 | try { 197 | if(null == msgObj) { 198 | return; 199 | } 200 | SendResult sendResult = producer.send(genMessage(topic, tag, msgObj)); 201 | log.info("send rocketmq message ,messageId : {}", sendResult.getMsgId()); 202 | this.doAfterSynSend(sendResult); 203 | } catch (Exception e) { 204 | log.error("消息发送失败，topic : {}, msgObj {}", topic, msgObj); 205 | throw new MQException("消息发送失败，topic :" + topic + ",e:" + e.getMessage()); 206 | } 207 | } 208 | 209 | /** 210 | * 同步发送消息 211 | * @param msgObj 消息体 212 | * @throws MQException 消息异常 213 | */ 214 | public void synSend(Object msgObj) throws MQException { 215 | synSend("", "", msgObj); 216 | } 217 | 218 | /** 219 | * 同步发送消息 220 | * @param tag 消息tag 221 | * @param msgObj 消息体 222 | * @throws MQException 消息异常 223 | */ 224 | public void synSend(String tag, Object msgObj) throws MQException { 225 | synSend("", tag, msgObj); 226 | } 227 | 228 | /** 229 | * 同步发送消息 230 | * @param topic topic 231 | * @param tag tag 232 | * @param msgObj 消息体 233 | * @param hashKey 用于hash后选择queue的key 234 | * @throws MQException 消息异常 235 | */ 236 | public void synSendOrderly(String topic, String tag, Object msgObj, String hashKey) throws MQException { 237 | if(null == msgObj) { 238 | return; 239 | } 240 | if(StringUtils.isEmpty(hashKey)) { 241 | // fall back to normal 242 | synSend(topic, tag, msgObj); 243 | } 244 | try { 245 | SendResult sendResult = producer.send(genMessage(topic, tag, msgObj), messageQueueSelector, hashKey); 246 | log.info("send rocketmq message orderly ,messageId : {}", sendResult.getMsgId()); 247 | this.doAfterSynSend(sendResult); 248 | } catch (Exception e) { 249 | log.error("顺序消息发送失败，topic : {}, msgObj {}", topic, msgObj); 250 | throw new MQException("顺序消息发送失败，topic :" + topic + ",e:" + e.getMessage()); 251 | } 252 | } 253 | 254 | /** 255 | * 异步发送消息带tag 256 | * @param topic topic 257 | * @param tag tag 258 | * @param msgObj msgObj 259 | * @param sendCallback 回调 260 | * @throws MQException 消息异常 261 | */ 262 | public void asynSend(String topic, String tag, Object msgObj, SendCallback sendCallback) throws MQException { 263 | try { 264 | if (null == msgObj) { 265 | return; 266 | } 267 | producer.send(genMessage(topic, tag, msgObj), sendCallback); 268 | log.info("send rocketmq message asyn"); 269 | } catch (Exception e) { 270 | log.error("消息发送失败，topic : {}, msgObj {}", topic, msgObj); 271 | throw new MQException("消息发送失败，topic :" + topic + ",e:" + e.getMessage()); 272 | } 273 | } 274 | 275 | /** 276 | * 异步发送消息不带tag和topic 277 | * @param msgObj msgObj 278 | * @param sendCallback 回调 279 | * @throws MQException 消息异常 280 | */ 281 | public void asynSend(Object msgObj, SendCallback sendCallback) throws MQException { 282 | asynSend("", "", msgObj, sendCallback); 283 | } 284 | 285 | /** 286 | * 异步发送消息不带tag和topic 287 | * @param tag msgtag 288 | * @param msgObj msgObj 289 | * @param sendCallback 回调 290 | * @throws MQException 消息异常 291 | */ 292 | public void asynSend(String tag, Object msgObj, SendCallback sendCallback) throws MQException { 293 | asynSend("", tag, msgObj, sendCallback); 294 | } 295 | 296 | /** 297 | * 异步发送消息带tag 298 | * @param topic topic 299 | * @param tag tag 300 | * @param msgObj msgObj 301 | * @param sendCallback 回调 302 | * @param hashKey 用于hash后选择queue的key 303 | * @throws MQException 消息异常 304 | */ 305 | public void asynSend(String topic, String tag, Object msgObj, SendCallback sendCallback, String hashKey) throws MQException { 306 | if (null == msgObj) { 307 | return; 308 | } 309 | if(StringUtils.isEmpty(hashKey)) { 310 | // fall back to normal 311 | asynSend(topic, tag, msgObj, sendCallback); 312 | } 313 | try { 314 | producer.send(genMessage(topic, tag, msgObj), messageQueueSelector, hashKey, sendCallback); 315 | log.info("send rocketmq message asyn"); 316 | } catch (Exception e) { 317 | log.error("消息发送失败，topic : {}, msgObj {}", topic, msgObj); 318 | throw new MQException("消息发送失败，topic :" + topic + ",e:" + e.getMessage()); 319 | } 320 | } 321 | 322 | /** 323 | * 兼容buick中的方式 324 | * 325 | * @deprecated please use more specific method 326 | * @param msgObj 消息体 327 | * @throws MQException 消息异常 328 | */ 329 | public void sendMessage(Object msgObj) throws MQException { 330 | if(StringUtils.isEmpty(getTopic())) { 331 | throw new MQException("如果用这种方式发送消息，请在实例中重写 getTopic() 方法返回需要发送的topic"); 332 | } 333 | sendOneWay("", "", msgObj); 334 | } 335 | 336 | /** 337 | * 重写此方法处理发送后的逻辑 338 | * 339 | * @param sendResult 发送结果 340 | */ 341 | public void doAfterSynSend(SendResult sendResult) {} 342 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------