rabbitmq可靠確認(rèn)模式的java封裝及示例

rabbitmq.png

最近的一個(gè)計(jì)費(fèi)項(xiàng)目段磨,在rpc調(diào)用和流式處理之間徘徊了許久镇饮,后來選擇流式處理蜓竹。一是可以增加吞吐量,二是事務(wù)的控制相比于rpc要容易很多。

確定了流式處理的方式俱济,后續(xù)是技術(shù)的選型嘶是。剛開始傾向于用storm,無奈文檔實(shí)在太少蛛碌,折騰起來著實(shí)費(fèi)勁聂喇。最終放棄,改用消息隊(duì)列+微服務(wù)的方式實(shí)現(xiàn)左医。

消息隊(duì)列的選型上授帕,有activemq同木,rabbitmq浮梢,kafka等。最開始傾向于用activemq彤路,因?yàn)橐郧暗捻?xiàng)目用過秕硝,很多代碼都是可直接復(fù)用的。后來看了不少文章對(duì)比洲尊,發(fā)現(xiàn)rabbitmq對(duì)多語言的支持更好一點(diǎn)远豺,同時(shí)相比于kafka,犧牲了部分的性能換取了更好的穩(wěn)定性安全性以及持久化坞嘀。

最終決定使用rabbitmq躯护。
rabbitmq的官網(wǎng)如下:

https://www.rabbitmq.com/

對(duì)rabbitmq的封裝,有幾個(gè)目標(biāo):
1 提供send接口
2 提供consume接口
3 保證消息的事務(wù)性處理

所謂事務(wù)性處理丽涩,是指對(duì)一個(gè)消息的處理必須嚴(yán)格可控棺滞,必須滿足原子性,只有兩種可能的處理結(jié)果:
(1) 處理成功矢渊,從隊(duì)列中刪除消息
(2) 處理失敗(網(wǎng)絡(luò)問題继准,程序問題,服務(wù)掛了)矮男,將消息重新放回隊(duì)列
為了做到這點(diǎn)移必,我們使用rabbitmq的手動(dòng)ack模式,這個(gè)后面細(xì)說毡鉴。

1 send接口

public interface MessageSender {    
    DetailRes send(Object message);
}

send接口相對(duì)簡單崔泵,我們使用spring的RabbitTemplate來實(shí)現(xiàn),代碼如下:

//1 構(gòu)造template, exchange, routingkey等
//2 設(shè)置message序列化方法
//3 設(shè)置發(fā)送確認(rèn)
//4 構(gòu)造sender方法
public MessageSender buildMessageSender(final String exchange, final String routingKey, final String queue) throws IOException, TimeoutException {
    Connection connection = connectionFactory.createConnection();
    //1
    buildQueue(exchange, routingKey, queue, connection);
    final RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);

    rabbitTemplate.setMandatory(true);
    rabbitTemplate.setExchange(exchange);
    rabbitTemplate.setRoutingKey(routingKey);
    //2
    rabbitTemplate.setMessageConverter(new Jackson2JsonMessageConverter());

    //3
    rabbitTemplate.setConfirmCallback(new RabbitTemplate.ConfirmCallback() {
        @Override
        public void confirm(CorrelationData correlationData, boolean ack, String cause) {
            if (!ack) {
                log.info("send message failed: " + cause); //+ correlationData.toString());
                throw new RuntimeException("send error " + cause);
            }
        }
    });

    //4
    return new MessageSender() {
        @Override
        public DetailRes send(Object message) {
            try {
                rabbitTemplate.convertAndSend(message);
            } catch (RuntimeException e) {
                e.printStackTrace();
                log.info("send failed " + e);

                try {
                    //retry
                    rabbitTemplate.convertAndSend(message);
                } catch (RuntimeException error) {
                    error.printStackTrace();
                    log.info("send failed again " + error);

                    return new DetailRes(false, error.toString());
                }
            }

            return new DetailRes(true, "");
        }
    };
}

2 consume接口

public interface MessageConsumer {    
    DetailRes consume();
}

在consume接口中猪瞬,會(huì)調(diào)用用戶自己的MessageProcess憎瘸,接口定義如下:

public interface MessageProcess<T> {    
    DetailRes process(T message);
}

consume的實(shí)現(xiàn)相對(duì)來說復(fù)雜一點(diǎn),代碼如下:

//1 創(chuàng)建連接和channel
//2 設(shè)置message序列化方法
//3 構(gòu)造consumer
public <T> MessageConsumer buildMessageConsumer(String exchange, String routingKey,
                                                final String queue, final MessageProcess<T> messageProcess) throws IOException {
    final Connection connection = connectionFactory.createConnection();

    //1
    buildQueue(exchange, routingKey, queue, connection);

    //2
    final MessagePropertiesConverter messagePropertiesConverter = new DefaultMessagePropertiesConverter();
    final MessageConverter messageConverter = new Jackson2JsonMessageConverter();

    //3
    return new MessageConsumer() {
        QueueingConsumer consumer;

        {
            consumer = buildQueueConsumer(connection, queue);
        }

        @Override
        //1 通過delivery獲取原始數(shù)據(jù)
        //2 將原始數(shù)據(jù)轉(zhuǎn)換為特定類型的包
        //3 處理數(shù)據(jù)
        //4 手動(dòng)發(fā)送ack確認(rèn)
        public DetailRes consume() {
            QueueingConsumer.Delivery delivery = null;
            Channel channel = consumer.getChannel();

            try {
                //1
                delivery = consumer.nextDelivery();
                Message message = new Message(delivery.getBody(),
                        messagePropertiesConverter.toMessageProperties(delivery.getProperties(), delivery.getEnvelope(), "UTF-8"));

                //2
                @SuppressWarnings("unchecked")
                T messageBean = (T) messageConverter.fromMessage(message);

                //3
                DetailRes detailRes = messageProcess.process(messageBean);

                //4
                if (detailRes.isSuccess()) {
                    channel.basicAck(delivery.getEnvelope().getDeliveryTag(), false);
                } else {
                    log.info("send message failed: " + detailRes.getErrMsg());
                    channel.basicNack(delivery.getEnvelope().getDeliveryTag(), false, true);
                }

                return detailRes;
            } catch (InterruptedException e) {
                e.printStackTrace();
                return new DetailRes(false, "interrupted exception " + e.toString());
            } catch (IOException e) {
                e.printStackTrace();
                retry(delivery, channel);
                log.info("io exception : " + e);

                return new DetailRes(false, "io exception " + e.toString());
            } catch (ShutdownSignalException e) {
                e.printStackTrace();

                try {
                    channel.close();
                } catch (IOException io) {
                    io.printStackTrace();
                } catch (TimeoutException timeout) {
                    timeout.printStackTrace();
                }

                consumer = buildQueueConsumer(connection, queue);

                return new DetailRes(false, "shutdown exception " + e.toString());
            } catch (Exception e) {
                e.printStackTrace();
                log.info("exception : " + e);
                retry(delivery, channel);

                return new DetailRes(false, "exception " + e.toString());
            }
        }
    };
}

3 保證消息的事務(wù)性處理
rabbitmq默認(rèn)的處理方式為auto ack撑螺,這意味著當(dāng)你從消息隊(duì)列取出一個(gè)消息時(shí)含思,ack自動(dòng)發(fā)送,mq就會(huì)將消息刪除。而為了保證消息的正確處理含潘,我們需要將消息處理修改為手動(dòng)確認(rèn)的方式饲做。
(1) sender的手工確認(rèn)模式
首先將ConnectionFactory的模式設(shè)置為publisherConfirms,如下

connectionFactory.setPublisherConfirms(true);

之后設(shè)置rabbitTemplate的confirmCallback遏弱,如下:

rabbitTemplate.setConfirmCallback(new RabbitTemplate.ConfirmCallback() {
    @Override
    public void confirm(CorrelationData correlationData, boolean ack, String cause) {
       if (!ack) {
           log.info("send message failed: " + cause); //+ correlationData.toString());
           throw new RuntimeException("send error " + cause);
       }
    }
});

(2) consume的手工確認(rèn)模式
首先在queue創(chuàng)建中指定模式

channel.exchangeDeclare(exchange, "direct", true, false, null);
/**
 * Declare a queue
 * @see com.rabbitmq.client.AMQP.Queue.Declare
 * @see com.rabbitmq.client.AMQP.Queue.DeclareOk
 * @param queue the name of the queue
 * @param durable true if we are declaring a durable queue (the queue will survive a server restart)
 * @param exclusive true if we are declaring an exclusive queue (restricted to this connection)
 * @param autoDelete true if we are declaring an autodelete queue (server will delete it when no longer in use)
 * @param arguments other properties (construction arguments) for the queue
 * @return a declaration-confirm method to indicate the queue was successfully declared
 * @throws java.io.IOException if an error is encountered
 */
channel.queueDeclare(queue, true, false, false, null);

只有在消息處理成功后發(fā)送ack確認(rèn)盆均,或失敗后發(fā)送nack使信息重新投遞

if (detailRes.isSuccess()) {
    channel.basicAck(delivery.getEnvelope().getDeliveryTag(), false);
} else {
    log.info("send message failed: " + detailRes.getErrMsg());
    channel.basicNack(delivery.getEnvelope().getDeliveryTag(), false, true);
}

4 自動(dòng)重連機(jī)制
為了保證rabbitmq的高可用性,我們使用rabbitmq Cluster模式漱逸,并配合haproxy泪姨。這樣,在一臺(tái)機(jī)器down掉時(shí)或者網(wǎng)絡(luò)發(fā)生抖動(dòng)時(shí)饰抒,就會(huì)發(fā)生當(dāng)前連接失敗的情況肮砾,如果不對(duì)這種情況做處理,就會(huì)造成當(dāng)前的服務(wù)不可用袋坑。
在spring-rabbitmq中仗处,已實(shí)現(xiàn)了connection的自動(dòng)重連,但是connection重連后枣宫,channel的狀態(tài)并不正確婆誓。因此我們需要自己捕捉ShutdownSignalException異常,并重新生成channel也颤。如下:

catch (ShutdownSignalException e) {
    e.printStackTrace();
    channel.close();
    //recreate channel
    consumer = buildQueueConsumer(connection, queue);
}

5 consumer線程池
在對(duì)消息處理的過程中洋幻,我們期望多線程并行執(zhí)行來增加效率,因此對(duì)consumer做了一個(gè)線程池的封裝翅娶。
線程池通過builder模式構(gòu)造文留,需要準(zhǔn)備如下參數(shù):

//線程數(shù)量
int threadCount;
//處理間隔(每個(gè)線程處理完成后休息的時(shí)間)
long intervalMils;
//exchange及queue信息
String exchange;
String routingKey;
String queue;
//用戶自定義處理接口
MessageProcess<T> messageProcess;

核心循環(huán)也較為簡單,代碼如下:

public void run() {
    while (!stop) {
        try {
            //2
            DetailRes detailRes = messageConsumer.consume();

            if (infoHolder.intervalMils > 0) {
                try {
                    Thread.sleep(infoHolder.intervalMils);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                    log.info("interrupt " + e);
                }
            }

            if (!detailRes.isSuccess()) {
                log.info("run error " + detailRes.getErrMsg());
            }
        } catch (Exception e) {
            e.printStackTrace();
            log.info("run exception " + e);
        }
    }
}

6 使用示例
最后故觅,我們還是用一個(gè)例子做結(jié)厂庇。
(1) 定義model

//參考lombok
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserMessage {
    int id;
    String name;
}

(2) rabbitmq配置
配置我們使用@Configuration實(shí)現(xiàn),如下:

@Configuration
public class RabbitMQConf {
    @Bean
    ConnectionFactory connectionFactory() {
        CachingConnectionFactory connectionFactory = new CachingConnectionFactory("127.0.0.1", 5672);

        connectionFactory.setUsername("guest");
        connectionFactory.setPassword("guest");
        connectionFactory.setPublisherConfirms(true); // enable confirm mode

        return connectionFactory;
    }
}

(3) sender示例

@Service
public class SenderExample {
    private static final String EXCHANGE = "example";
    private static final String ROUTING = "user-example";
    private static final String QUEUE = "user-example";

    @Autowired
    ConnectionFactory connectionFactory;

    private MessageSender messageSender;

    @PostConstruct
    public void init() throws IOException, TimeoutException {
        MQAccessBuilder mqAccessBuilder = new MQAccessBuilder(connectionFactory);
        messageSender = mqAccessBuilder.buildMessageSender(EXCHANGE, ROUTING, QUEUE);
    }

    public DetailRes send(UserMessage userMessage) {
        return messageSender.send(userMessage);
    }
}

(4) MessageProcess(用戶自定義處理接口)示例输吏,本例中我們只是簡單的將信息打印出來

public class UserMessageProcess implements MessageProcess<UserMessage> {
    @Override
    public DetailRes process(UserMessage userMessage) {
        System.out.println(userMessage);

        return new DetailRes(true, "");
    }
}

(5) consumer示例

@Service
public class ConsumerExample {
    private static final String EXCHANGE = "example";
    private static final String ROUTING = "user-example";
    private static final String QUEUE = "user-example";

    @Autowired
    ConnectionFactory connectionFactory;

    private MessageConsumer messageConsumer;

    @PostConstruct
    public void init() throws IOException, TimeoutException {
        MQAccessBuilder mqAccessBuilder = new MQAccessBuilder(connectionFactory);
        messageConsumer = mqAccessBuilder.buildMessageConsumer(EXCHANGE, ROUTING, QUEUE, new UserMessageProcess());
    }

    public DetailRes consume() {
        return messageConsumer.consume();
    }
}

(6) 線程池consumer示例
在main函數(shù)中权旷,我們使用一個(gè)獨(dú)立線程發(fā)送數(shù)據(jù),并使用線程池接收數(shù)據(jù)贯溅。

@Service
public class PoolExample {
    private static final String EXCHANGE = "example";
    private static final String ROUTING = "user-example";
    private static final String QUEUE = "user-example";

    @Autowired
    ConnectionFactory connectionFactory;

    private ThreadPoolConsumer<UserMessage> threadPoolConsumer;

    @PostConstruct
    public void init() {
        MQAccessBuilder mqAccessBuilder = new MQAccessBuilder(connectionFactory);
        MessageProcess<UserMessage> messageProcess = new UserMessageProcess();

        threadPoolConsumer = new ThreadPoolConsumer.ThreadPoolConsumerBuilder<UserMessage>()
                .setThreadCount(Constants.THREAD_COUNT).setIntervalMils(Constants.INTERVAL_MILS)
                .setExchange(EXCHANGE).setRoutingKey(ROUTING).setQueue(QUEUE)
                .setMQAccessBuilder(mqAccessBuilder).setMessageProcess(messageProcess)
                .build();
    }

    public void start() throws IOException {
        threadPoolConsumer.start();
    }

    public void stop() {
        threadPoolConsumer.stop();
    }

    public static void main(String[] args) throws IOException {
        ApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml");
        PoolExample poolExample = ac.getBean(PoolExample.class);
        final SenderExample senderExample = ac.getBean(SenderExample.class);

        poolExample.start();

        new Thread(new Runnable() {
            int id = 0;

            @Override
            public void run() {
                while (true) {
                    senderExample.send(new UserMessage(id++, "" + System.nanoTime()));

                    try {
                        Thread.sleep(1000L);
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                }
            }
        }).start();
    }
}

7 github地址拄氯,路過的幫忙點(diǎn)個(gè)星星,謝謝_它浅。

https://github.com/littlersmall/rabbitmq-access

附:
rabbitmq安裝過程:
mac版安裝可以使用homebrew译柏。brew install就可以,安裝好之后通過brew services start rabbitmq啟動(dòng)服務(wù)姐霍。通過

http://localhost:15672/#/

就可以在頁面端看到rabbitmq了鄙麦,如下:


rabbitmq_manager.png

have fun

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末典唇,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子胯府,更是在濱河造成了極大的恐慌介衔,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,941評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件骂因,死亡現(xiàn)場離奇詭異炎咖,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)寒波,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,397評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門乘盼,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人俄烁,你說我怎么就攤上這事绸栅。” “怎么了猴娩?”我有些...
    開封第一講書人閱讀 165,345評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵阴幌,是天一觀的道長勺阐。 經(jīng)常有香客問我卷中,道長,這世上最難降的妖魔是什么渊抽? 我笑而不...
    開封第一講書人閱讀 58,851評(píng)論 1 295
  • 正文 為了忘掉前任蟆豫,我火速辦了婚禮,結(jié)果婚禮上懒闷,老公的妹妹穿的比我還像新娘十减。我一直安慰自己,他們只是感情好愤估,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,868評(píng)論 6 392
  • 文/花漫 我一把揭開白布帮辟。 她就那樣靜靜地躺著,像睡著了一般玩焰。 火紅的嫁衣襯著肌膚如雪由驹。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,688評(píng)論 1 305
  • 那天昔园,我揣著相機(jī)與錄音蔓榄,去河邊找鬼。 笑死默刚,一個(gè)胖子當(dāng)著我的面吹牛甥郑,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播荤西,決...
    沈念sama閱讀 40,414評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼澜搅,長吁一口氣:“原來是場噩夢啊……” “哼伍俘!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起勉躺,我...
    開封第一講書人閱讀 39,319評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤养篓,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后赂蕴,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體柳弄,經(jīng)...
    沈念sama閱讀 45,775評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評(píng)論 3 336
  • 正文 我和宋清朗相戀三年概说,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了碧注。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,096評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡糖赔,死狀恐怖萍丐,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情放典,我是刑警寧澤逝变,帶...
    沈念sama閱讀 35,789評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站奋构,受9級(jí)特大地震影響壳影,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜弥臼,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,437評(píng)論 3 331
  • 文/蒙蒙 一宴咧、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧径缅,春花似錦掺栅、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,993評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至氏堤,卻和暖如春沙绝,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背丽猬。 一陣腳步聲響...
    開封第一講書人閱讀 33,107評(píng)論 1 271
  • 我被黑心中介騙來泰國打工宿饱, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人脚祟。 一個(gè)月前我還...
    沈念sama閱讀 48,308評(píng)論 3 372
  • 正文 我出身青樓谬以,卻偏偏與公主長得像,于是被迫代替她去往敵國和親由桌。 傳聞我的和親對(duì)象是個(gè)殘疾皇子为黎,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,037評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容

  • http://liuxing.info/2017/06/30/Spring%20AMQP%E4%B8%AD%E6%...
    sherlock_6981閱讀 15,925評(píng)論 2 11
  • 什么叫消息隊(duì)列 消息(Message)是指在應(yīng)用間傳送的數(shù)據(jù)邮丰。消息可以非常簡單,比如只包含文本字符串铭乾,也可以更復(fù)雜...
    lijun_m閱讀 1,348評(píng)論 0 1
  • 1.什么是消息隊(duì)列 消息隊(duì)列允許應(yīng)用間通過消息的發(fā)送與接收的方式進(jìn)行通信剪廉,當(dāng)消息接收方服務(wù)忙或不可用時(shí),其提供了一...
    zhuke閱讀 4,469評(píng)論 0 12
  • 本文章翻譯自http://www.rabbitmq.com/api-guide.html炕檩,并沒有及時(shí)更新斗蒋。 術(shù)語對(duì)...
    joyenlee閱讀 7,660評(píng)論 0 3
  • 概述 本文介紹一下AMQP協(xié)議和RabbitMQ中幾個(gè)比較重要的方法 AMQP 我們知道RabbitMQ是遵從AM...
    Tian_Peng閱讀 2,087評(píng)論 0 1