[rocketmq.wiki] branch master updated: Updated RIP 2 RocketMQ Spring (markdown)

[du...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

duhengforever pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq.wiki.git


The following commit(s) were added to refs/heads/master by this push:
     new c9a7570  Updated RIP 2 RocketMQ Spring (markdown)
c9a7570 is described below

commit c9a7570314d3e5e4556b1135f4723fa8511569d9
Author: Heng Du <du...@gmail.com>
AuthorDate: Wed Jan 9 15:39:18 2019 +0800

    Updated RIP 2 RocketMQ Spring (markdown)
---
 RIP-2-RocketMQ-Spring.md | 50 +++++++++++++++++++++++++++---------------------
 1 file changed, 28 insertions(+), 22 deletions(-)

diff --git a/RIP-2-RocketMQ-Spring.md b/RIP-2-RocketMQ-Spring.md
index c5b42ce..5a76d5a 100644
--- a/RIP-2-RocketMQ-Spring.md
+++ b/RIP-2-RocketMQ-Spring.md
@@ -1,10 +1,11 @@
 # Status
-Current State: Proposed
-Authors: Kevin Wang
-Shepherds: Vongosling
-Mailing List Discussion: <apache mailing list archive>
-Pull Request: #PR_NUMBER
-Released: <released_version>
+Current State: Proposed    
+Authors: Kevin Wang     
+Shepherds: Vongosling     
+Mailing List Discussion: <apache mailing list archive>     
+Pull Request: #PR_NUMBER      
+Released: <released_version>     
+
 # Background & Motivation
 ## What do we need to do
 Apache RocketMQ is the top-level project of the Apache Software Foundation, which is used widely both in both China and the rest of the world  by more and more developers, it provides convenient and multi-language APIs. 
@@ -35,7 +36,10 @@ This is an accessional project to generate an embedded RocketMQ Broker in a stan
 Distributed transactional message is an important new feature in RocketMQ 4.3.0 release, we need this function in spring-rocketmq producer API.
 Currently the project has supported the following features:
 RocketMQTemplate: It provides a "template" as a high-level abstraction for sending messages;
+
+```
 @RocktMQMessageListener: The annotation works with Message-driven POJOs and implements callback method to consume messages.
+
 @RocketMQMessageListener(topic = "${spring.rocketmq.topic}", consumerGroup = "string_consumer")
 public class StringConsumer implements RocketMQListener<String> {
    @Override
@@ -43,9 +47,10 @@ public class StringConsumer implements RocketMQListener<String> {
        log.info("------- StringConsumer received: {}", message);
    }
 }
-
+```
 The enhancement will add the below changes on producer side:
 1. Add new annotation @RocketMQTransactionListener to define Executor and Checker implementations
+```
 @RocketMQTransactionListener(transName = TRANS_NAME)
 class TransactionListenerImpl implements TransactionListener {
    @Override
@@ -58,7 +63,9 @@ class TransactionListenerImpl implements TransactionListener {
       ...
    }
 }
+```
 2. Add new methods to send transactional message in RocketMQTemplate class:
+```
 public TransactionSendResult sendMessageInTransaction(String txProducerName, org.apache.rocketmq.common.message.Message rocketMsg, Object arg) throws MQClientException {
    ...
 }
@@ -66,21 +73,20 @@ public TransactionSendResult sendMessageInTransaction(String txProducerName, org
 public TransactionSendResult sendMessageInTransaction(String txProducerName, String destination, org.springframework.message.Message<?>msg, Object arg) throws MQClientException {
    ...
 }
-
-## Enhancement 3:  Enrich code comments and reformat 
-In order to pull request (or become a new) Spring project, we’d like to refactor the source code to add more comments and format with Spring concepts.  Reference the below section:     
-
-None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.
-Use the Spring Framework code format conventions (import eclipse-code-formatter.xml from the root of the project if you are using Eclipse).
-Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for.
+```
+## Enhancement 3:  Enrich code comments and reformat     
+In order to pull request (or become a new) Spring project, we’d like to refactor the source code to add more comments and format with Spring concepts.    
+Reference the below section:      
+None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.      
+Use the Spring Framework code format conventions (import eclipse-code-formatter.xml from the root of the project if you are using Eclipse).     
+Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for.    
 Add the ASF license header comment to all new .java files (copy from existing files in the project)
-Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).
-Add some Javadocs and, if you change the namespace, some XSD doc elements.
-A few unit tests would help a lot as well - someone has to do it.
-If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
-
-It might be required to change the package name of each classes before doing the final merge.
+Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).    
+Add some Javadocs and, if you change the namespace, some XSD doc elements.   
+A few unit tests would help a lot as well - someone has to do it.    
+If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).     
+It might be required to change the package name of each classes before doing the final merge.     
 ## Enhancement 4:  Demo and Tutorial docment
-For users quickly start to use the spring-rocketmq, we will provide demo and usage document. 
-The orginal demo project is in https://github.com/aqlu/rocketmq-demo.git. The enhancement will move it into the RocketMQ samples project and with completed documentation.
+For users quickly start to use the spring-rocketmq, we will provide demo and usage document.    
+The orginal demo project is in https://github.com/aqlu/rocketmq-demo.git. The enhancement will move it into the RocketMQ samples project and with completed documentation.