ali-concurrent.xml 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  1. <?xml version="1.0"?>
  2. <ruleset name="AlibabaJavaConcurrent"
  3. xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
  4. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  5. xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
  6. <rule name="ThreadPoolCreationRule"
  7. language="java"
  8. since="1.6"
  9. message="java.concurrent.ThreadPoolCreationRule.rule.msg"
  10. class="com.alibaba.p3c.pmd.lang.java.rule.concurrent.ThreadPoolCreationRule">
  11. <description>java.concurrent.ThreadPoolCreationRule.rule.desc</description>
  12. <priority>1</priority>
  13. <example>
  14. <![CDATA[
  15. Positive example 1:
  16. //org.apache.commons.lang3.concurrent.BasicThreadFactory
  17. ScheduledExecutorService executorService = new ScheduledThreadPoolExecutor(1,
  18. new BasicThreadFactory.Builder().namingPattern("example-schedule-pool-%d").daemon(true).build());
  19. ]]>
  20. </example>
  21. <example>
  22. <![CDATA[
  23. Positive example 2:
  24. ThreadFactory namedThreadFactory = new ThreadFactoryBuilder()
  25. .setNameFormat("demo-pool-%d").build();
  26. //Common Thread Pool
  27. ExecutorService pool = new ThreadPoolExecutor(5, 200,
  28. 0L, TimeUnit.MILLISECONDS,
  29. new LinkedBlockingQueue<Runnable>(1024), namedThreadFactory, new ThreadPoolExecutor.AbortPolicy());
  30. pool.execute(()-> System.out.println(Thread.currentThread().getName()));
  31. pool.shutdown();//gracefully shutdown
  32. ]]>
  33. </example>
  34. <example>
  35. <![CDATA[
  36. Positive example 3:
  37. <bean id="userThreadPool"
  38. class="org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor">
  39. <property name="corePoolSize" value="10" />
  40. <property name="maxPoolSize" value="100" />
  41. <property name="queueCapacity" value="2000" />
  42. <property name="threadFactory" value= threadFactory />
  43. <property name="rejectedExecutionHandler">
  44. <ref local="rejectedExecutionHandler" />
  45. </property>
  46. </bean>
  47. //in code
  48. userThreadPool.execute(thread);
  49. ]]>
  50. </example>
  51. </rule>
  52. <rule name="AvoidUseTimerRule"
  53. language="java"
  54. since="1.6"
  55. message="java.concurrent.AvoidUseTimerRule.rule.msg"
  56. class="com.alibaba.p3c.pmd.lang.java.rule.concurrent.AvoidUseTimerRule">
  57. <priority>1</priority>
  58. <example>
  59. <![CDATA[
  60. //org.apache.commons.lang3.concurrent.BasicThreadFactory
  61. ScheduledExecutorService executorService = new ScheduledThreadPoolExecutor(1,
  62. new BasicThreadFactory.Builder().namingPattern("example-schedule-pool-%d").daemon(true).build());
  63. executorService.scheduleAtFixedRate(new Runnable() {
  64. @Override
  65. public void run() {
  66. //do something
  67. }
  68. },initialDelay,period, TimeUnit.HOURS);
  69. ]]>
  70. </example>
  71. </rule>
  72. <rule name="AvoidManuallyCreateThreadRule"
  73. language="java"
  74. since="1.6"
  75. message="java.concurrent.AvoidManuallyCreateThreadRule.rule.msg"
  76. dfa="true"
  77. class="com.alibaba.p3c.pmd.lang.java.rule.concurrent.AvoidManuallyCreateThreadRule">
  78. <description>java.concurrent.AvoidManuallyCreateThreadRule.rule.desc</description>
  79. <priority>2</priority>
  80. <example>
  81. <![CDATA[
  82. ThreadFactory namedThreadFactory = new ThreadFactoryBuilder()
  83. .setNameFormat("demo-pool-%d").build();
  84. ExecutorService singleThreadPool = new ThreadPoolExecutor(1, 1,
  85. 0L, TimeUnit.MILLISECONDS,
  86. new LinkedBlockingQueue<Runnable>(1024), namedThreadFactory, new ThreadPoolExecutor.AbortPolicy());
  87. singleThreadPool.execute(()-> System.out.println(Thread.currentThread().getName()));
  88. singleThreadPool.shutdown();
  89. ]]>
  90. </example>
  91. </rule>
  92. <rule name="ThreadShouldSetNameRule"
  93. language="java"
  94. since="1.6"
  95. message="java.concurrent.ThreadShouldSetNameRule.rule.msg"
  96. dfa="true"
  97. class="com.alibaba.p3c.pmd.lang.java.rule.concurrent.ThreadShouldSetNameRule">
  98. <priority>2</priority>
  99. <example>
  100. <![CDATA[
  101. ThreadFactory namedThreadFactory = new ThreadFactoryBuilder()
  102. .setNameFormat("demo-pool-%d").build();
  103. ExecutorService singleThreadPool = new ThreadPoolExecutor(1, 1,
  104. 0L, TimeUnit.MILLISECONDS,
  105. new LinkedBlockingQueue<Runnable>(1024), namedThreadFactory, new ThreadPoolExecutor.AbortPolicy());
  106. singleThreadPool.execute(()-> System.out.println(Thread.currentThread().getName()));
  107. singleThreadPool.shutdown();
  108. ]]>
  109. </example>
  110. <example>
  111. <![CDATA[
  112. public class TimerTaskThread extends Thread {
  113. public TimerTaskThread() {
  114. super.setName("TimerTaskThread");
  115. // do something
  116. }
  117. }
  118. ]]>
  119. </example>
  120. </rule>
  121. <rule name="AvoidCallStaticSimpleDateFormatRule"
  122. language="java"
  123. since="1.6"
  124. message="java.concurrent.AvoidCallStaticSimpleDateFormatRule.rule.msg"
  125. dfa="true"
  126. class="com.alibaba.p3c.pmd.lang.java.rule.concurrent.AvoidCallStaticSimpleDateFormatRule">
  127. <description>java.concurrent.AvoidCallStaticSimpleDateFormatRule.rule.desc</description>
  128. <example>
  129. <![CDATA[
  130. Positive example 1:
  131. private static final String FORMAT = "yyyy-MM-dd HH:mm:ss";
  132. public String getFormat(Date date) {
  133. SimpleDateFormat dateFormat = new SimpleDateFormat(FORMAT);
  134. return dateFormat.format(date);
  135. }
  136. ]]>
  137. </example>
  138. <example>
  139. <![CDATA[
  140. Positive example 2:
  141. private static final SimpleDateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  142. public void getFormat() {
  143. synchronized(SIMPLE_DATE_FORMAT) {
  144. SIMPLE_DATE_FORMAT.format(new Date());
  145. // do something
  146. }
  147. }
  148. ]]>
  149. </example>
  150. <example>
  151. <![CDATA[
  152. Positive example 3:
  153. private static final ThreadLocal<DateFormat> DATE_FORMATTER = new ThreadLocal<DateFormat>() {
  154. @Override
  155. protected DateFormat initialValue() {
  156. return new SimpleDateFormat("yyyy-MM-dd");
  157. }
  158. };
  159. ]]>
  160. </example>
  161. <priority>2</priority>
  162. </rule>
  163. <rule name="ThreadLocalShouldRemoveRule"
  164. language="java"
  165. since="1.6"
  166. message="java.concurrent.ThreadLocalShouldRemoveRule.rule.msg"
  167. dfa="true"
  168. class="com.alibaba.p3c.pmd.lang.java.rule.concurrent.ThreadLocalShouldRemoveRule">
  169. <priority>2</priority>
  170. <example>
  171. <![CDATA[
  172. /**
  173. * @author caikang
  174. * @date 2017/04/07
  175. */
  176. public class UserHolder {
  177. private static final ThreadLocal<User> userThreadLocal = new ThreadLocal<User>();
  178. public static void set(User user){
  179. userThreadLocal.set(user);
  180. }
  181. public static User get(){
  182. return userThreadLocal.get();
  183. }
  184. public static void remove(){
  185. userThreadLocal.remove();
  186. }
  187. }
  188. /**
  189. * @author caikang
  190. * @date 2017/04/07
  191. */
  192. public class UserInterceptor extends HandlerInterceptorAdapter {
  193. @Override
  194. public boolean preHandle(HttpServletRequest request,
  195. HttpServletResponse response, Object handler) throws Exception {
  196. UserHolder.set(new User());
  197. return true;
  198. }
  199. @Override
  200. public void afterCompletion(HttpServletRequest request,
  201. HttpServletResponse response, Object handler, Exception ex) throws Exception {
  202. UserHolder.remove();
  203. }
  204. }
  205. ]]>
  206. </example>
  207. </rule>
  208. <rule name="AvoidConcurrentCompetitionRandomRule"
  209. language="java"
  210. since="1.6"
  211. message="java.concurrent.AvoidConcurrentCompetitionRandomRule.rule.msg"
  212. dfa="true"
  213. class="com.alibaba.p3c.pmd.lang.java.rule.concurrent.AvoidConcurrentCompetitionRandomRule">
  214. <priority>3</priority>
  215. <example>
  216. <![CDATA[
  217. Positive example 1:
  218. /**
  219. * @author caikang
  220. * @date 2017/04/07
  221. */
  222. public class RandomInThread extends Thread {
  223. private Random random = new Random();
  224. @Override
  225. public void run() {
  226. long t = random.nextLong();
  227. }
  228. }
  229. ]]>
  230. </example>
  231. <example>
  232. <![CDATA[
  233. Positive example 2:
  234. /**
  235. * @author caikang
  236. * @date 2017/04/07
  237. */
  238. public class RandomInThread extends Thread {
  239. private Random random = ThreadLocalRandom.current();
  240. @Override
  241. public void run() {
  242. long t = random.nextLong();
  243. }
  244. }
  245. ]]>
  246. </example>
  247. </rule>
  248. <rule name="CountDownShouldInFinallyRule"
  249. language="java"
  250. since="1.6"
  251. message="java.concurrent.CountDownShouldInFinallyRule.rule.msg"
  252. dfa="true"
  253. class="com.alibaba.p3c.pmd.lang.java.rule.concurrent.CountDownShouldInFinallyRule">
  254. <description>java.concurrent.CountDownShouldInFinallyRule.rule.desc</description>
  255. <priority>3</priority>
  256. <example>
  257. <![CDATA[
  258. /**
  259. * @author caikang
  260. * @date 2017/04/07
  261. */
  262. public class CountDownExample {
  263. public void operate(CountDownLatch countDownLatch){
  264. try{
  265. System.out.println("business logic");
  266. }catch (RuntimeException e){
  267. // do something
  268. }finally {
  269. countDownLatch.countDown();
  270. }
  271. }
  272. }
  273. ]]>
  274. </example>
  275. </rule>
  276. </ruleset>