Skip to content

Commit a375ac4

Browse files
author
骏烈
committed
Source code
1 parent f1e2331 commit a375ac4

File tree

306 files changed

+23554
-11
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

306 files changed

+23554
-11
lines changed

‎.gitignore

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Gradle
2+
build
3+
.gradle
4+
5+
testdata/
6+
# Java gitignore #
7+
.class
8+
.log
9+
10+
# Package Files #
11+
12+
*.war
13+
*.ear
14+
15+
#hsf files
16+
configuration
17+
18+
# maven gitignore#
19+
target/**
20+
21+
.svn/
22+
23+
# intelliJ.gitignore #
24+
.idea
25+
*.iml
26+
*.ipr
27+
*.iws
28+
29+
30+
# Eclipse git ignore#
31+
*.pydevproject
32+
.project
33+
.metadata
34+
bin/**
35+
*/bin/**
36+
tmp/**
37+
tmp/**/*
38+
configuration/**
39+
*.tmp
40+
*.bak
41+
*.orig
42+
*.swp
43+
*~.nib
44+
.classpath
45+
.settings/
46+
.loadpath
47+
.fileTable*
48+
.cache
49+
50+
# External tool builders
51+
.externalToolBuilders/
52+
53+
# Locally stored "Eclipse launch configurations"
54+
*.launch
55+
56+
# CDT-specific
57+
.cproject
58+
59+
# PDT-specific
60+
.buildpath
61+
62+
#log
63+
*.log
64+
*.log.*
65+
66+
# Windows Thumbs.db
67+
*.db
68+
69+
# OSX
70+
.DS_Store
71+
72+
# sass gitignore#
73+
.sass-cache
74+
.idea
75+
76+
# tcc_coverage
77+
coverage.ec
78+
79+
80+
81+
config.client.*
82+
83+
temp/
84+
*.pid
85+
*.orig
86+
87+
hsf.configuration/
88+
89+
# code coverage report
90+
*.ec
91+
92+
#hsf test
93+
*.instance
94+
out
95+
!/p3c-idea/src/main/kotlin/com/alibaba/smartfox/work/tools/aone/ui/AoneBranchView.kt

‎README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,35 @@
1-
## 代码规约插件全球首发
2-
![倒计时_](https://gw.alicdn.com/tfscom/TB1il8pf6ihSKJjy0FeXXbJtpXa.jpg)
3-
10月14日杭州云栖大会上会，代码规约插件及源码，将在杭州云栖大会上[研发效能峰会](https://yunqi.aliyun.com/2017/hangzhou/meeting?day=day4&theme=all&meeting=detail1433 )的首发仪式上全球首发。
1+
Java代码规约扫描插件已在[研发协同RDC](https://rdc-test.aliyun.com)（云效公有云解决方案）的测试功能中实现（设置->测试服务->阿里巴巴Java代码规约）。
42

5-
过去的整整一年中，阿里内部经历过无数次针锋相对的讨论，与实战经验相结合，系统性地从编程，数据库，异常日志，工程结构，安全，单元测试（new）六个维度总结做为Java合格开发者必备的技术素养。只是文档让开发同学遵守是非常困难的，阿里研发一套自动检测插件——代码规约扫描插件，已在[研发协同RDC](https://rdc-test.aliyun.com/)（云效公有云解决方案）的实验室功能中实现。
3+
# P3C
64

7-
[![alt text](https://gw.alicdn.com/tfscom/TB13OnghlUSMeJjy1zkXXaWmpXa.png "title")](https://rdc-test.aliyun.com)
8-
点图可在线扫描代码合规情况
5+
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
96

10-
“开发手册”主要作者孤尽在10月13日的云栖大会上分享“从推动的Java的代码规约谈技术人成长的有所为”，欢迎大家到场零距离沟通。
7+
## <font color="green">Preface</font>
8+
> We are pleased to present Alibaba Java Coding Guidelines, which consolidates the best programming practices over the years from Alibaba Group's technical teams. A vast number of Java programming teams impose demanding requirements on code quality across projects as we encourage reuse and better understanding of each other's programs. We have seen many programming problems in the past. For example, defective database table structures and index designs may cause software architecture flaws and performance risks. Yet as another example, confusing code structures make it difficult to maintain. Furthermore, vulnerable code without authentication is prone to hackers’ attacks. To address those kinds of problems, we developed this document for Java developers in Alibaba.
9+
10+
For more information please refer the *Alibaba Java Coding Guidelines*:
11+
- 中文版: *[阿里巴巴Java开发手册](https://github.com/alibaba/p3c/blob/master/%E9%98%BF%E9%87%8C%E5%B7%B4%E5%B7%B4Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C%EF%BC%88%E7%BB%88%E6%9E%81%E7%89%88%EF%BC%89.pdf)*
12+
- English Version: *[Alibaba Java Coding Guidelines](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines)*
1113

12-
电子工业出版社也将在一年后出版孤尽参与编写的“码出高效 - 阿里巴巴的Java开发手册详解”这本书。
14+
## <font color="green">Introduction</font>
15+
The project consists of 3 parts:
16+
- [PMD implementations](p3c-pmd)
17+
- [IntelliJ IDEA plugin](idea-plugin)
18+
- [Eclipse plugin](eclipse-plugin)
1319

14-
代码规约最新更新消息关注“代码规约”微信公众号：
20+
## <font color="green">Rules</font>
21+
<font color="blue">49 rules are realized based on PMD, please refer the P3C-PMD documentation for more detailed information. 4 rules implemented within IDE plugins (IDEA and Eclipse) as following:</font>
1522

16-
![代码规约](https://gw.alicdn.com/tfscom/TB1x5WJaGmgSKJjSsphXXcy1VXa.jpg)
23+
- ``[Mandatory]`` Using a deprecated class or method is prohibited.
24+
Note: For example, decode(String source, String encode) should be used instead of the deprecated method decode(String encodeStr). Once an interface has been deprecated, the interface provider has the obligation to provide a new one. At the same time, client programmers have the obligation to check out what its new implementation is.
25+
26+
- ``[Mandatory]`` An overridden method from an interface or abstract class must be marked with @Override annotation.
27+
Counter example: For getObject() and get0bject(), the first one has a letter 'O', and the second one has a number '0'. To accurately determine whether the overriding is successful, an @Override annotation is necessary. Meanwhile, once the method signature in the abstract class is changed, the implementation class will report a compile-time error immediately.
28+
29+
- ``[Mandatory]`` A static field or method should be directly referred by its class name instead of its corresponding object name.
30+
31+
- ``[Mandatory]`` The usage of hashCode and equals should follow:
32+
1. Override hashCode if equals is overridden.
33+
2. These two methods must be overridden for Set since they are used to ensure that no duplicate object will be inserted in Set.
34+
3. These two methods must be overridden if self-defined object is used as the key of Map.
35+
Note: String can be used as the key of Map since these two methods have been rewritten.

‎eclipse-plugin/.gitignore

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Gradle
2+
build
3+
.gradle
4+
5+
testdata/
6+
# Java gitignore #
7+
.class
8+
.log
9+
10+
# Package Files #
11+
12+
*.war
13+
*.ear
14+
15+
#hsf files
16+
configuration
17+
18+
# maven gitignore#
19+
target/**
20+
21+
.svn/
22+
23+
# intelliJ.gitignore #
24+
.idea
25+
*.iml
26+
*.ipr
27+
*.iws
28+
*.bat
29+
30+
# Eclipse git ignore#
31+
*.pydevproject
32+
.project
33+
.metadata
34+
bin/**
35+
*/bin/**
36+
tmp/**
37+
tmp/**/*
38+
configuration/**
39+
*.tmp
40+
*.bak
41+
*.orig
42+
*.swp
43+
*~.nib
44+
.classpath
45+
.settings/
46+
.loadpath
47+
.fileTable*
48+
.cache
49+
50+
# External tool builders
51+
.externalToolBuilders/
52+
53+
# Locally stored "Eclipse launch configurations"
54+
*.launch
55+
56+
# CDT-specific
57+
.cproject
58+
59+
# PDT-specific
60+
.buildpath
61+
62+
#log
63+
*.log
64+
*.log.*
65+
66+
# Windows Thumbs.db
67+
*.db
68+
69+
# OSX
70+
.DS_Store
71+
72+
# sass gitignore#
73+
.sass-cache
74+
.idea
75+
76+
# tcc_coverage
77+
coverage.ec
78+
79+
80+
81+
config.client.*
82+
83+
temp/
84+
*.pid
85+
*.orig
86+
87+
hsf.configuration/
88+
89+
# code coverage report
90+
*.ec
91+
92+
#hsf test
93+
*.instance
94+
**/target
95+
.pmd
96+
**/.pmd

‎eclipse-plugin/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Eclipse Plugin
2+
---
3+
## <font color="green">Prepare</font>
4+
- Eclipse Juno+
5+
- maven3.+
6+
- JDK 1.7+
7+
8+
## <font color="green">Build</font>
9+
```
10+
mvn -U clean install
11+
```
12+
13+
## <font color="green">Install</font>
14+
1. <font color="blue">Help >> Install New Software
15+
then enter this update site URL [https://p3c.alibaba.com/plugin/eclipse/update](https://p3c.alibaba.com/plugin/eclipse/update)</font>
16+
17+
![Install Plugin](doc/images/install.png)
18+
19+
2. <font color="blue">Follow the wizard, restart Eclipse to take effect after install success.</font>
20+
21+
## <font color="green">Use</font>
22+
1. <font color="blue">Switch language</font>
23+
24+
![Switch language](doc/images/eclipse_switch_language.png)
25+
26+
2. <font color="blue">Code Analyze </font>
27+
28+
![Analyze](doc/images/eclipse_analyze.png)
29+
30+
![Analyze](doc/images/analyze_result.png)
31+

‎eclipse-plugin/com.alibaba.smartfox.eclipse.feature/build.properties

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
bin.includes = feature.xml,\
2+
feature.properties,\
3+
smartfox.png
4+
src.includes = build.properties,\
5+
feature.properties,\
6+
feature.xml,\
7+
smartfox.png

‎eclipse-plugin/com.alibaba.smartfox.eclipse.feature/feature.properties

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
feature.label = Ali-CodeAnalysis
2+
feature.provider_name = Alibaba
3+
feature.update_site_name = Alibaba IDE Portal
4+
5+
description.text = Alibaba Java Coding Guidelines
6+
description.url = https://github.com/alibaba/p3c
7+
8+
copyright.text =\
9+
Copyright 2017 Alibaba Java Coding Guidelines
10+
11+
license.url = https://github.com/alibaba/p3c
12+
license.text =\
13+
Copyright 1999-2017 Alibaba Group. \n\
14+
\n\
15+
Licensed under the Apache License, Version 2.0 (the "License"); \n\
16+
you may not use this file except in compliance with the License. \n\
17+
You may obtain a copy of the License at \n\
18+
\n\
19+
http://www.apache.org/licenses/LICENSE-2.0 \n\
20+
\n\
21+
Unless required by applicable law or agreed to in writing, software \n\
22+
distributed under the License is distributed on an "AS IS" BASIS, \n\
23+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. \n\
24+
See the License for the specific language governing permissions and \n\
25+
limitations under the License. \n\
26+

‎eclipse-plugin/com.alibaba.smartfox.eclipse.feature/feature.xml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<feature
3+
id="com.alibaba.smartfox.eclipse.feature"
4+
label="%feature.label"
5+
version="1.0.0.qualifier"
6+
provider-name="%feature.provider_name"
7+
plugin="com.alibaba.smartfox.eclipse.plugin"
8+
image="smartfox.png">
9+
10+
<description url="%description.url">
11+
Alibaba Java Coding Guidelines
12+
</description>
13+
14+
<copyright>
15+
%copyright.text
16+
</copyright>
17+
18+
<license url="%license.url">
19+
%license.text
20+
</license>
21+
22+
<url>
23+
<update label="%feature.update_site_name" url="https://p3c.alibaba.com/plugin/eclipse/update"/>
24+
</url>
25+
26+
<requires>
27+
<import plugin="org.eclipse.ui"/>
28+
<import plugin="org.eclipse.core.runtime"/>
29+
<import plugin="org.eclipse.jdt.core"/>
30+
<import plugin="org.eclipse.ui.ide"/>
31+
<import plugin="org.eclipse.ui.views"/>
32+
<import plugin="org.eclipse.core.resources"/>
33+
<import plugin="org.eclipse.jface.text"/>
34+
<import plugin="org.eclipse.ui.workbench.texteditor"/>
35+
<import plugin="org.eclipse.ltk.core.refactoring"/>
36+
<import plugin="org.eclipse.jdt.ui"/>
37+
<import plugin="org.eclipse.core.filebuffers"/>
38+
</requires>
39+
40+
<plugin
41+
id="com.alibaba.smartfox.eclipse.plugin"
42+
download-size="0"
43+
install-size="0"
44+
version="0.0.0"/>
45+
46+
</feature>

‎eclipse-plugin/com.alibaba.smartfox.eclipse.feature/pom.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
4+
<modelVersion>4.0.0</modelVersion>
5+
<parent>
6+
<groupId>com.alibaba.smartfox.eclipse</groupId>
7+
<artifactId>smartfox-eclipse</artifactId>
8+
<version>1.0.0-SNAPSHOT</version>
9+
</parent>
10+
<artifactId>com.alibaba.smartfox.eclipse.feature</artifactId>
11+
<packaging>eclipse-feature</packaging>
12+
<inceptionYear>2017</inceptionYear>
13+
</project>

‎eclipse-plugin/com.alibaba.smartfox.eclipse.feature/smartfox.png

2.53 KB
Loading

0 commit comments

Comments
 (0)