Skip to content

Commit aabcbcb

Browse files
mimulmimul
committed
코드 정적 분석 추가
1 parent 420b44f commit aabcbcb

File tree

5 files changed

+360
-1
lines changed

5 files changed

+360
-1
lines changed

‎README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ StartUp 소프트웨어 개발 조직이 갖추어야 할 문화
99
- [Mac에서 git 환경](https://github.com/mimul/dev-environment/blob/master/mac-git.md)
1010
- [개발 프로세스 가이드](https://github.com/mimul/dev-environment/blob/master/dev-process.md): 최신 드랜드를 반영한 최소한의 개발 프로세스에 대한 가이드를 제공한다.(Trello + Github + Slack)
1111
- [코드 리뷰](https://github.com/mimul/dev-environment/blob/master/code-review.md) : 코드 리뷰에 필요한 정보들을 정리해 제공한다.
12-
- 리팩토링 가이드(Comming soon) : 좋은 코드를 작성하기 위한 몇가지 지침을 제공한다.
12+
- 코드 개선
13+
- [정적 분석](https://github.com/wiseeco/dev-environment/blob/master/static-analysis.md)
14+
- 리팩토링 가이드(Comming soon) : 좋은 코드를 작성하기 위한 몇가지 지침을 제공한다.
1315
- [Markdown Template](https://github.com/mimul/dev-environment/blob/master/markdown-template.md) : 필요한 Markdown 문법 등 사용 가이드 제공해 활용도를 높여준다.
1416
- 기술 블로그(Comming soon)
1517

‎build-config/checkstyle/wiseeco-checks.xml

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<?xml version="1.0"?>
2+
<!-- Date: 2015-10-04 -->
3+
<!-- Author : Wiseeco -->
4+
<!-- Description : checkstyle rules-->
5+
<!DOCTYPE module PUBLIC
6+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
7+
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
8+
<module name="Checker">
9+
10+
<module name="TreeWalker">
11+
<!-- Checks for blocks. You know, those {}'s -->
12+
<!-- See http://checkstyle.sf.net/config_blocks.html -->
13+
<module name="EmptyBlock" />
14+
<module name="LeftCurly" />
15+
<module name="RightCurly" />
16+
<module name="AvoidNestedBlocks" />
17+
18+
<!-- Coding -->
19+
<!-- See http://checkstyle.sourceforge.net/config_coding.html -->
20+
<module name="EmptyStatement" />
21+
<module name="HiddenField"/>
22+
<module name="IllegalInstantiation"/>
23+
<module name="ModifiedControlVariable"/>
24+
<module name="SimplifyBooleanExpression"/>
25+
<module name="IllegalCatch"/>
26+
<module name="FallThrough"/>
27+
28+
<!-- Checks for imports -->
29+
<!-- See http://checkstyle.sf.net/config_import.html -->
30+
<module name="AvoidStarImport" />
31+
<module name="IllegalImport" />
32+
<module name="RedundantImport" />
33+
<module name="UnusedImports" />
34+
35+
<!-- Checks for Javadoc comments. -->
36+
<!-- See http://checkstyle.sf.net/config_javadoc.html
37+
<module name="JavadocMethod" />
38+
<module name="JavadocType" />
39+
<module name="JavadocStyle" />-->
40+
41+
<!-- Checks for Naming Conventions. -->
42+
<!-- See http://checkstyle.sf.net/config_naming.html-->
43+
<module name="ConstantName" />
44+
<module name="LocalFinalVariableName" /><!-- 변수 이름은 카멜 표기법 -->
45+
<module name="MemberName"><!-- 변수 이름은 카멜 표기법 -->
46+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
47+
<message key="name.invalidPattern"
48+
value="Member name ''{0}'' must match pattern ''{1}''."/>
49+
</module>
50+
<module name="MethodName"><!-- 메소드는 카멜 표기법 -->
51+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
52+
<message key="name.invalidPattern"
53+
value="Method name ''{0}'' must match pattern ''{1}''."/>
54+
</module>
55+
<module name="ParameterName"><!-- 변수 이름은 카멜 표기법 -->
56+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
57+
<message key="name.invalidPattern"
58+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
59+
</module>
60+
<module name="StaticVariableName" /><!-- 변수 이름은 카멜 표기법 -->
61+
<module name="TypeName"><!-- 클래스, 인터페이스 이름은 파스칼 표기법 -->
62+
<message key="name.invalidPattern"
63+
value="Type name ''{0}'' must match pattern ''{1}''."/>
64+
</module>
65+
<module name="PackageName">
66+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
67+
<message key="name.invalidPattern"
68+
value="Package name ''{0}'' must match pattern ''{1}''."/>
69+
</module>
70+
71+
<!-- Checks for whitespace -->
72+
<!-- See http://checkstyle.sf.net/config_whitespace.html
73+
<module name="EmptyForIteratorPad" />
74+
<module name="GenericWhitespace" />
75+
<module name="MethodParamPad" />
76+
<module name="OperatorWrap" />
77+
<module name="ParenPad" />
78+
<module name="TypecastParenPad" />
79+
<module name="WhitespaceAfter" />
80+
<module name="WhitespaceAround" />-->
81+
<module name="MethodParamPad" />
82+
<!--<module name="MagicNumber" />-->
83+
84+
</module>
85+
</module>

‎build-config/eslint/.eslintrc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"rules": {
3+
"linebreak-style": [
4+
2,
5+
"unix"
6+
],
7+
"semi": [
8+
2,
9+
"always"
10+
]
11+
},
12+
"env": {
13+
"browser": true
14+
},
15+
"extends": "eslint:recommended"
16+
}

‎build-config/findbugs/findbugs-exclude-filter.xml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- Date: 2015-10-04 -->
2+
<!-- Author : Wiseeco -->
3+
<!-- Description : exclude filter rules-->
4+
<FindBugsFilter>
5+
<Match>
6+
<Class name="~.*\.*Test" />
7+
</Match>
8+
<Match>
9+
<Bug pattern="DM_NUMBER_CTOR" />
10+
</Match>
11+
<Match>
12+
<Bug pattern="BAC_BAD_APPLET_CONSTRUCTOR" />
13+
</Match>
14+
<Match>
15+
<Bug pattern="USM_USELESS_SUBCLASS_METHOD" />
16+
</Match>
17+
<Match>
18+
<Bug pattern="FB_MISSING_EXPECTED_WARNING" />
19+
</Match>
20+
<Match>
21+
<Bug pattern="FB_UNEXPECTED_WARNING" />
22+
</Match>
23+
</FindBugsFilter>

‎static-analysis.md

Lines changed: 233 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,233 @@
1+
코드 정적 분석 가이드
2+
======================
3+
개발자가 코드를 작성함에 있어서
4+
5+
- 기존에 공유된 코딩 스타일을 위반하거나,
6+
- 잠재적 버그의 가능성이 있는 코드들,
7+
- 클래스나 패키지간의 종속성 등 설계상의 문제가 되는 코드들,
8+
- 중복된 코드
9+
10+
등의 문제를 쉽게 찾아주는 정적 분석도구를 잘 활용해 리팩토링하기전에 최소한의 코드 품질을 유지하는 것을 보장하고자 이 문서를 작성한다. 기본 환경은 Java, Javascript 언어에 한정한다.
11+
12+
Checkstyle
13+
---
14+
코딩 스타일에서의 벗어난 코드들을 알려준다.
15+
16+
###설정
17+
18+
[wiseeco-checkstyle.xml][wiseeco-checkstyle] 파일을 프로젝트 ROOT에 다운로드한 다음, Checkstyle-IDE 플러그인은 로딩 이슈가 있어서 설치를 제외하고, pom.xml에 아래 사항을 기술해 준다.
19+
```
20+
<plugin>
21+
<groupId>org.apache.maven.plugins</groupId>
22+
<artifactId>maven-checkstyle-plugin</artifactId>
23+
<version>${checkstyle-version}</version>
24+
<configuration>
25+
<configLocation>wiseeco-checkstyle.xml</configLocation>
26+
</configuration>
27+
</plugin>
28+
```
29+
intellij의 Maven Project탭에서 Plugins아래 checkstyle에서 checkstyle:checkstyle을 실행하면 결과를 보여준다. 결과중에 Warning을 하나씩 잡아가면 된다. 실행 주기는 커밋하기 전에 한번 실행해서 확인한다.
30+
31+
###설정 정보
32+
1. [blocks](http://checkstyle.sf.net/config_blocks.html)
33+
```
34+
AvoidNestedBlocks : 중첩된 블록 체크.
35+
EmptyBlock : 빈 블록 체크.
36+
LeftCurly : 중괄호 {의 위치 체크.
37+
RightCurly : 오른쪽 중괄호 }의 위치 체크.
38+
```
39+
40+
2. [Coding](http://checkstyle.sourceforge.net/config_coding.html)
41+
```
42+
EmptyStatement : 빈줄 확인.
43+
HiddenField : 동일한 클래스 내에서 정의된 필드와 같은 이름의 지역 변수와 메소드 매개 변수가 존재하는지 여부를 체크.
44+
IllegalInstantiation : 잘못된 인스턴스 사용 체크.
45+
ModifiedControlVariable : for 문의 증감 부분에 설명 된 변수를 블록으로 변경하고 있는지 여부 체크.
46+
SimplifyBooleanExpression : 중복 연산 체크.
47+
IllegalCatch : 부적절한 Catch 사용 체크.
48+
FallThrough : case문에 break문이 정의되지 않은 부분 체크.
49+
```
50+
51+
3. [imports](http://checkstyle.sf.net/config_import.html)
52+
```
53+
AvoidStarImport : .* 형식의 import 문장을 체크.
54+
IllegalImport : import하면 안되는 패키지 체크.
55+
RedundantImport : 중복 import 문을 체크.
56+
UnusedImports : 프로그램에서 사용되지 않는 import 문을 체크.
57+
```
58+
59+
4. [Naming Conventions](http://checkstyle.sf.net/config_naming.htm)
60+
```
61+
ConstantName : 상수(static, final)의 명명 규칙을 설정. 기본값은 ^[A-Z][A-Z0-9]+(_[A-Z0-9]+)*$.
62+
LocalFinalVariableName : final 로컬 변수 명명 규칙을 설정(카멜 표기법). ^[a-z][a-z0-9][a-zA-Z0-9]*$.
63+
MemberName : static이 아닌 필드(변수) 명명 규칙을 설정(카멜 표기법). ^[a-z][a-z0-9][a-zA-Z0-9]*$.
64+
MethodName : 메소드의 명명 규칙을 설정(카멜 표기법). ^[a-z][a-z0-9][a-zA-Z0-9]*$.
65+
ParameterName : 매개 변수의 명명 규칙(카멜 표기법). ^[a-z][a-z0-9][a-zA-Z0-9]*$.
66+
StaticVariableName : static변수 명명 규칙을 설정(카멜 표기법). ^[a-z][a-z0-9][a-zA-Z0-9]*$.
67+
TypeName : 클래스나 인터페이스의 명명 규칙을 설정(파스칼 표기법). ^[A-Z][a-zA-Z0-9]+$.
68+
PackageName : 패키지의 명명 규칙을 설정. ^[a-z]+(\.[a-z][a-z0-9]*)*$.
69+
```
70+
71+
5. [whitespace](http://checkstyle.sf.net/config_whitespace.html)
72+
```
73+
MethodParamPad : 메소드 정의 부분(호출 부분도 포함)의 공백을 체크.
74+
```
75+
76+
FindBugs
77+
---
78+
알려진 버그 패턴에 따라 잠재적 버그를 검사해 알려준다.
79+
80+
###설정
81+
[findbugs-exclude-filter.xml][findbugs-exclude-filter] 파일을 프로젝트 ROOT에 다운로드한 다음, pom.xml에 아래 사항을 기술해 준다.
82+
```
83+
<plugin>
84+
<groupId>org.codehaus.mojo</groupId>
85+
<artifactId>findbugs-maven-plugin</artifactId>
86+
<version>${findbugs-version}</version>
87+
<configuration>
88+
<excludeFilterFile>findbugs-exclude-filter.xml</excludeFilterFile>
89+
<!--<includeFilterFile>findbugs-include-filter.xml</includeFilterFile>-->
90+
</configuration>
91+
</plugin>
92+
```
93+
intellij의 Maven Project탭에서 Plugins아래 findbugs에서 findbugs:findbugs실행 후 findbugs:gui를 실행해서 Warning들을 처리해 나간다. findbugs 실행 주기도 커밋 시점에 한번 실행해서 확인한다.
94+
95+
###오류메세지 정보
96+
1. Correctness
97+
```
98+
Possible null pointer dereference in method on exception path : 예외가 발생했을 경우에 null 포인터가 참조될 가능성 있음.
99+
Nullcheck of value previously dereferenced : 중복 널 체크.
100+
Uninitialized read of field in constructor : 생성자 초기회 이전에 필드를 사용하고 있음.
101+
Invocation of toString on an array : 배열을 toString하고 있음.[C@16f0472 같은 의미없는 문자열)
102+
```
103+
104+
2. Bad practice
105+
```
106+
Method ignores results of InputStream.read() : InputStream.read() 메소드의 반환 값을 무시하고 있음.
107+
Method names should start with a lower case letter : 함수명이 카멜케이스가 아님.
108+
Method may fail to close stream : 메소드에서 생성된 스트림이 close되지 않고 종료될 가능성이 있음.
109+
```
110+
111+
3. Experimental
112+
```
113+
Method may fail to clean up stream or resource on checked exception : 메소드에서 생성된 스트림이나 리소스가 close되지 않은 채 메소드가 종료 될 가능성이 있음
114+
```
115+
116+
4. Internationalization
117+
```
118+
Reliance on default encoding : 디폴트 인코딩 지정 안했을 경우. String.getBytes(), new String(bytes) 등 인코딩 정보를 빠진 경우 디폴트 인코딩 정보 등록해야 함.
119+
```
120+
121+
5. Multithreaded correctness
122+
```
123+
Call to static DateFormat : DateFormat 객체의 사용은 멀티 스레드에 안전하지 않음.
124+
```
125+
126+
6. Performance
127+
```
128+
Boxed value is unboxed and then immediately reboxed : Box된 값이 바로 Unbox 되는 부분이 있음.
129+
Boxing/unboxing to parse a primitive : primitive 타입을 강제 Box, Unbox 한 부분이 있음.
130+
Unread field : 읽혀지지 않는 필드가 존재함.
131+
```
132+
133+
7. Dodgy code
134+
```
135+
Result of integer multiplication cast to long : 정수(int)의 곱셈 결과를 long으로 변환함.
136+
Dead store to local variable : 로드되지 않는 로컬 변수에 쓰기 작업을 수행하고 있음.
137+
Parameter must be non-null but is marked as nullable : 파라미터는 널이 아니어야하는데 널일수도 있음.
138+
Check for oddness that won't work for negative numbers : 음수에 대해서는 동작하지 않을수도 있음.
139+
Exception is caught when Exception is not thrown : Exception이 발생하지 않는 곳에서 Exception을 캐치하고 있음.
140+
Switch statement found where default case is missing : default문이 없음.
141+
Useless object created : 의미없는 객체 생성문이 있음.
142+
Dead store of null to local variable : 로컬 변수에 null을 할당해서 GC대상이 되게 하는 방법은 java 6.0이상에서는 더이상 불필요함.
143+
```
144+
145+
[ESLint](http://eslint.org/)
146+
---
147+
Javascript의 알려진 버그들을 알려준다.
148+
149+
###ESLint의 특징
150+
- 모든 규칙을 자유롭게 on/off 할 수 있음.
151+
- 자신의 프로젝트에 맞게 사용자 정의 규칙을 만들어서 사용 가능.
152+
- 풍부한 내장 규칙 이외에 많은 플러그인이 공개되어 있음.
153+
- ECMAScript 2015(ES6)를 지원.
154+
- React의 JSX 기법을 지원.
155+
- Babel과 연계하여 ECMAScript 2016(ES7) 이후의 구문과 Flow형 주석에도 대응함.
156+
- 지속적으로 소스 업데이트가 진행되고 있음.
157+
158+
###설치 및 사용법
159+
```
160+
> npm install -g eslint
161+
> eslint -v
162+
> eslint --init
163+
{
164+
"rules": {
165+
"linebreak-style": [
166+
2,
167+
"unix"
168+
],
169+
"semi": [
170+
2,
171+
"always"
172+
]
173+
},
174+
"env": {
175+
"browser": true
176+
},
177+
"extends": "eslint:recommended"
178+
}
179+
> eslint src/main/webapp/resources/app/common/utils/helpers.js
180+
```
181+
"extends": "eslint:recommended" 라인만 있어도 소스 분석해 문제점을 나열해 준다. 실행주기는 커밋시점에 한번 실행하고 위의 마지막 라인에서처럼 변경된 javascript파일을 실행해서 점검한다.
182+
183+
###설정 정보
184+
1. Possible Errors
185+
```
186+
comma-dangle : 마지막 쉼표있을 경우 경고.(예: [1, 2, 3,])
187+
no-cond-assign : 조건식안에 대입식이 있을 경우 경고.(예 : if(a = 10) {})
188+
no-console : 소스에 console 로그가 있으면 경고.
189+
no-constant-condition : 조건식이 상수라면 경고.(예 : if (true) {})
190+
no-control-regex : 정규 표현식 중에 ASCII 제어 문자가 존재하면 경고.
191+
no-debugger : debugger 문 경고.
192+
no-dupe-args : 인수 이름이 중복되면 경고.(예 : function foo (a, a) {})
193+
no-dupe-keys : 속성 이름이 중복되면 경고.(예 : var foo = {a : 0, a : 1};)
194+
no-duplicate-case : case 절이 중복되면 경고.(예 : switch (foo) {case 0 : case 0 :})
195+
no-empty-character-class : 정규 표현식에 널문자 집합이 존재하면 경고.(예 : var foo = /abc[]/;)
196+
no-empty : 빈 블럭이 있으면 경고.
197+
no-ex-assign : catch 절에 예외 변수에 다시 대입문이 있으면 경고.(예 : try {} catch (err) {err = 0;})
198+
no-extra-boolean-cast : 조건식 안에 !!연산을 경고.(예 : if (!!a) {})
199+
no-extra-semi : 불필요한 세미콜론을 경고.(예 : var a = 0;;)
200+
no-func-assign : 함수에 대입하면 경고.(예 : function foo () {} foo = 0;)
201+
no-inner-declarations : 함수 이외의 블록 안에 함수 선언을 경고.(예 : if (a) {function foo () {}})
202+
no-invalid-regexp : RegExp 생성자에 잘못된 문자열을 작성하면 경고.(예 : new RegExp ("[/");)
203+
no-irregular-whitespace : 부적절한 공백을 경고.
204+
no-negated-in-lhs : in 연산자의 좌변 값이 예기치 않은 연산자인 경우에 경고.(예 : if (! a in foo) {})
205+
no-obj-calls : 함수가 아닌 내장 변수에 대한 함수 호출을 경고.
206+
no-regex-spaces : 정규식 파싱동안 연속적인 공백이 존재한다면 경고.
207+
no-sparse-arrays : 스파스 배열 리터럴을 경고.(예 : var a = [0, 1,, 3];)
208+
no-unreachable : 도달할 수없는 코드에 경고.(예 : function foo () {return; var a = 0;})
209+
use-isnan : NaN 과의 비교를 경고.(예 : if (foo == NaN) {})
210+
valid-typeof : typeof 비교를 경고.(예 : if (typeof a == "strong") {})
211+
```
212+
213+
2. Best Practices
214+
```
215+
no-fallthrough : switch 구문 fall through를 경고.(예 : switch (a) {case 0 : foo(); default: bar();})
216+
no-octal : 8진수 리터럴을 경고.(예 : var a = 0755;)
217+
no-redeclare : 변수의 재 선언을 경고.(예 : var a = 0; var a = 1;)
218+
```
219+
220+
3. Variables
221+
```
222+
no-delete-var : 변수에 delete 식을 경고.
223+
no-undef : 정의되지 않은 변수에 대한 참조를 경고.
224+
no-unused-vars : 선언했지만, 사용되지 않은 변수를 경고.
225+
```
226+
227+
4. Stylistic Issues
228+
```
229+
no-mixed-spaces-and-tabs : 공백과 탭이 혼재하고 있는 경우에 경고.
230+
```
231+
232+
[wiseeco-checkstyle]: https://github.com/wiseeco/dev-culture/blob/master/wiseeco-checkstyle.xml
233+
[findbugs-exclude-filter]: https://github.com/wiseeco/dev-culture/blob/master/findbugs-exclude-filter.xml

0 commit comments

Comments
 (0)