Ver3.0 ๐ ์๋ฐ ์ฝ๋ ํ์ง๊ณผ ์ ์ ๋ถ์ ๋๊ตฌ ์์ ์ ๋ณต

๐ ์๋ฐ ์ฝ๋ ํ์ง๊ณผ ์ ์ ๋ถ์ ๋๊ตฌ ์์ ์ ๋ณต
SonarQube์ SpotBugs๋ก ์ฝ๋ ํ์ง์ ํ ๋จ๊ณ ์ ๊ทธ๋ ์ด๋ํ๋ ์ค์ ๊ฐ์ด๋ ๐
์์ฆ ๊ฐ๋ฐ ํธ๋ ๋๋ฅผ ๋ณด๋ฉด ๋จ์ํ "๋์๊ฐ๋ ์ฝ๋"๋ฅผ ๋์ด์ "์ข์ ์ฝ๋"๋ฅผ ์์ฑํ๋ ๊ฒ ์ ๋ง ์ค์ํด์ก์ด. ํนํ ํ ํ๋ก์ ํธ๋ ๋๊ท๋ชจ ์๋น์ค๋ฅผ ๊ฐ๋ฐํ ๋๋ ์ฝ๋ ํ์ง์ด ๊ณง ์์ฐ์ฑ์ด๊ณ , ์ ์ง๋ณด์ ๋น์ฉ์ด๊ฑฐ๋ . ์ฌ๋ฅ๋ท ๊ฐ์ ํ๋ซํผ์์๋ ํ๋ก๊ทธ๋๋ฐ ๊ด๋ จ ์ฌ๋ฅ์ ๊ฑฐ๋ํ ๋ "์ฝ๋ ํ์ง ๊ด๋ฆฌ ๋ฅ๋ ฅ"์ ์ ๋ง ์ค์ํ ์คํฌ๋ก ํ๊ฐ๋ฐ๊ณ ์์ด! ๐ช
๋ค๋ฅธ ๊ฐ๋ฐ์๊ฐ ๋ดค์ ๋ ์ฝ๊ฒ ์ดํดํ ์ ์๋ ์ฝ๋์ผ. 6๊ฐ์ ํ์ ๋ด๊ฐ ๋ด๋ "์, ์ด๊ฑฐ ๋ด๊ฐ ์ ์ด๋ ๊ฒ ์งฐ์ง?" ํ์ง ์๋ ์ฝ๋ ๋ง์ด์ผ. ๐ ๋ณ์๋ช , ํจ์๋ช ์ด ๋ช ํํ๊ณ , ์ ์ ํ ์ฃผ์์ด ์์ผ๋ฉฐ, ์ผ๊ด๋ ์ฝ๋ฉ ์คํ์ผ์ ๋ฐ๋ฅด๋ ๊ฒ ์ค์ํด.
2. ์ ์ง๋ณด์์ฑ (Maintainability)
์ฝ๋๋ฅผ ์์ ํ๊ฑฐ๋ ๊ธฐ๋ฅ์ ์ถ๊ฐํ ๋ ์ผ๋ง๋ ์ฌ์ด๊ฐ๋ฅผ ๋ํ๋ด. ์ ๊ตฌ์กฐํ๋ ์ฝ๋๋ ํ ๋ถ๋ถ์ ์์ ํด๋ ๋ค๋ฅธ ๋ถ๋ถ์ ์ํฅ์ ์ต์ํํ ์ ์์ด. ์ด๊ฒ ๋ฐ๋ก "๋์จํ ๊ฒฐํฉ(Loose Coupling)"๊ณผ "๋์ ์์ง๋(High Cohesion)"์ ์์น์ด์ง.
3. ์ ๋ขฐ์ฑ (Reliability)
์์์น ๋ชปํ ์ํฉ์์๋ ์์ ์ ์ผ๋ก ๋์ํ๋ ์ฝ๋๋ฅผ ๋งํด. ์์ธ ์ฒ๋ฆฌ๊ฐ ์ ๋์ด ์๊ณ , ์ฃ์ง ์ผ์ด์ค๋ฅผ ๊ณ ๋ คํ ์ฝ๋๊ฐ ์ ๋ขฐ์ฑ ๋์ ์ฝ๋์ผ. ๋ฒ๊ทธ๊ฐ ์ ๊ณ , ์๋๋ผ๋ ์ฝ๊ฒ ์ฐพ์ ์ ์๋ ๊ตฌ์กฐ๋ฉด ๊ธ์์ฒจํ! ๐
4. ํจ์จ์ฑ (Efficiency)
์๊ฐ ๋ณต์ก๋์ ๊ณต๊ฐ ๋ณต์ก๋๋ฅผ ๊ณ ๋ คํ ์ต์ ํ๋ ์ฝ๋. ๋ฌผ๋ก "์กฐ๊ธฐ ์ต์ ํ๋ ๋ง์ ์ ๊ทผ์"์ด๋ผ๋ ๋ง๋ ์์ง๋ง, ๋ช ๋ฐฑํ ๋นํจ์จ์ ์ธ ์ฝ๋๋ ํผํด์ผ ํด. ํนํ ๋์ฉ๋ ๋ฐ์ดํฐ๋ฅผ ๋ค๋ฃจ๊ฑฐ๋ ์ค์๊ฐ ์ฒ๋ฆฌ๊ฐ ํ์ํ ๊ฒฝ์ฐ์ ๋์ฑ ์ค์ํ์ง.
5. ๋ณด์์ฑ (Security)
SQL ์ธ์ ์ , XSS, CSRF ๊ฐ์ ๋ณด์ ์ทจ์ฝ์ ์ด ์๋ ์ฝ๋. ์์ฆ์ ๋ณด์์ด ์ ๋ง ์ค์ํด์, ์ฝ๋ ๋ ๋ฒจ์์๋ถํฐ ๋ณด์์ ๊ณ ๋ คํ์ง ์์ผ๋ฉด ํฐ ์ฌ๊ณ ๋ก ์ด์ด์ง ์ ์์ด. ๐ฑ
6. ํ ์คํธ ๊ฐ๋ฅ์ฑ (Testability)
๋จ์ ํ ์คํธ๋ฅผ ์์ฑํ๊ธฐ ์ฌ์ด ๊ตฌ์กฐ์ ์ฝ๋. ์์กด์ฑ์ด ๋ช ํํ๊ณ , ๊ฐ ๋ชจ๋์ด ๋ ๋ฆฝ์ ์ผ๋ก ํ ์คํธ ๊ฐ๋ฅํ ๊ตฌ์กฐ๋ฉด ์ข์. TDD(Test-Driven Development)๋ฅผ ์ค์ฒํ๊ธฐ์๋ ์ ๋ฆฌํ์ง.
โข ์ปดํ์ผ ํ์์ ๋ฌธ์ ๋ฐ๊ฒฌ
โข ๋ชจ๋ ์ฝ๋ ๊ฒฝ๋ก๋ฅผ ๊ฒ์ฌ ๊ฐ๋ฅ
โข ๋น ๋ฅด๊ณ ์๋ํํ๊ธฐ ์ฌ์
โข ์: SonarQube, SpotBugs, PMD, Checkstyle
๋์ ๋ถ์ (Dynamic Analysis)
โข ํ๋ก๊ทธ๋จ์ ์คํํ๋ฉด์ ๋ถ์
โข ๋ฐํ์์ ๋ฌธ์ ๋ฐ๊ฒฌ
โข ์ค์ ์คํ๋ ๊ฒฝ๋ก๋ง ๊ฒ์ฌ
โข ์ค์ ํ๊ฒฝ์์์ ๋์ ํ์ธ
โข ์: JUnit, Mockito, JProfiler, VisualVM
ํ์์ ์ ํ ์ฝ๋ฉ ์ปจ๋ฒค์ ์ ์งํค์ง ์์ ๋ถ๋ถ์ ์ฐพ์๋ด. ์๋ฅผ ๋ค์ด ๋ณ์๋ช ์ด camelCase๊ฐ ์๋๋ผ snake_case๋ก ๋์ด ์๋ค๊ฑฐ๋, ๋ค์ฌ์ฐ๊ธฐ๊ฐ ์ผ๊ด๋์ง ์์ ๊ฒฝ์ฐ ๋ฑ์ด์ผ.
2. ์ ์ฌ์ ๋ฒ๊ทธ
Null Pointer Exception์ด ๋ฐ์ํ ์ ์๋ ์ฝ๋, ๋ฆฌ์์ค ๋์(Resource Leak), ๋ฌดํ ๋ฃจํ ๊ฐ๋ฅ์ฑ ๋ฑ์ ๋ฏธ๋ฆฌ ๊ฒฝ๊ณ ํด์ค. ์ด๋ฐ ๊ฑด ์คํํด๋ณด๊ธฐ ์ ๊น์ง๋ ๋ชจ๋ฅผ ์๋ ์๋๋ฐ, ์ ์ ๋ถ์ ๋๊ตฌ๊ฐ ๋ฏธ๋ฆฌ ์๋ ค์ฃผ๋ ๊ฑฐ์ง.
3. ๋ณด์ ์ทจ์ฝ์
SQL ์ธ์ ์ , ํ๋์ฝ๋ฉ๋ ๋น๋ฐ๋ฒํธ, ์์ ํ์ง ์์ ์ํธํ ์๊ณ ๋ฆฌ์ฆ ์ฌ์ฉ ๋ฑ ๋ณด์ ๋ฌธ์ ๋ฅผ ํ์งํด. OWASP Top 10 ๊ฐ์ ์ฃผ์ ๋ณด์ ์ทจ์ฝ์ ๋ค์ ์ฒดํฌํ ์ ์์ด. ๐
4. ์ฑ๋ฅ ๋ฌธ์
๋นํจ์จ์ ์ธ ์๊ณ ๋ฆฌ์ฆ, ๋ถํ์ํ ๊ฐ์ฒด ์์ฑ, ์๋ชป๋ ์ปฌ๋ ์ ์ฌ์ฉ ๋ฑ ์ฑ๋ฅ์ ์ํฅ์ ์ค ์ ์๋ ์ฝ๋๋ฅผ ์ฐพ์๋ด. ์๋ฅผ ๋ค์ด ๋ฃจํ ์์์ String ์ฐ๊ฒฐ์ + ์ฐ์ฐ์๋ก ํ๋ ๋์ StringBuilder๋ฅผ ์ฌ์ฉํ๋ผ๊ณ ์ ์ํ๋ ์์ด์ผ.
5. ์ฝ๋ ๋ณต์ก๋
์ํ ๋ณต์ก๋(Cyclomatic Complexity)๊ฐ ๋๋ฌด ๋๊ฑฐ๋, ๋ฉ์๋๊ฐ ๋๋ฌด ๊ธธ๊ฑฐ๋, ํด๋์ค๊ฐ ๋๋ฌด ๋ง์ ์ฑ ์์ ๊ฐ์ง๊ณ ์๋ ๊ฒฝ์ฐ๋ฅผ ์ง์ ํด. ์ด๋ฐ ์ฝ๋๋ ์ดํดํ๊ธฐ ์ด๋ ต๊ณ ๋ฒ๊ทธ๊ฐ ์จ์ด์๊ธฐ ์ฌ์.
6. ์ค๋ณต ์ฝ๋
๊ฐ์ ๋ก์ง์ด ์ฌ๋ฌ ๊ณณ์ ๋ฐ๋ณต๋๋ ๊ฑธ ์ฐพ์๋ด. DRY(Don't Repeat Yourself) ์์น์ ์งํค๋๋ก ๋์์ฃผ์ง. ์ค๋ณต ์ฝ๋๋ ์ ์ง๋ณด์์ ์ ์ด๊ฑฐ๋ ! ๐ค
โข False Negative (๊ฑฐ์ง ์์ฑ): ์ค์ ๋ฌธ์ ๊ฐ ์๋๋ฐ ๋ฐ๊ฒฌํ์ง ๋ชปํ๋ ๊ฒฝ์ฐ
โข Code Smell: ๋น์ฅ ๋ฒ๊ทธ๋ ์๋์ง๋ง ๋์ค์ ๋ฌธ์ ๊ฐ ๋ ์ ์๋ ์ฝ๋ ํจํด
โข Technical Debt: ๋น ๋ฅธ ๊ฐ๋ฐ์ ์ํด ํ์ง์ ํฌ์ํ ๊ฒฐ๊ณผ๋ก ์์ด๋ "๊ธฐ์ ๋ถ์ฑ"
SonarQube์ ํต์ฌ ๊ธฐ๋ฅ:
1. ์ง์์ ์ธ ์ฝ๋ ๊ฒ์ฌ (Continuous Inspection)
CI/CD ํ์ดํ๋ผ์ธ์ ํตํฉ๋์ด ์ฝ๋๊ฐ ์ปค๋ฐ๋ ๋๋ง๋ค ์๋์ผ๋ก ๋ถ์์ ์ํํด. Jenkins, GitLab CI, GitHub Actions ๋ฑ๊ณผ ์ฝ๊ฒ ์ฐ๋ํ ์ ์์ด. ์ด๋ ๊ฒ ํ๋ฉด ๋ฌธ์ ๊ฐ ์๋ ์ฝ๋๊ฐ ๋ฉ์ธ ๋ธ๋์น์ ๋จธ์ง๋๊ธฐ ์ ์ ๋ฏธ๋ฆฌ ์ฐจ๋จํ ์ ์์ง! ๐ซ
2. ํ์ง ๊ฒ์ดํธ (Quality Gate)
์ฝ๋๊ฐ ํน์ ํ์ง ๊ธฐ์ค์ ๋ง์กฑํ์ง ๋ชปํ๋ฉด ๋น๋๋ฅผ ์คํจ์ํฌ ์ ์์ด. ์๋ฅผ ๋ค์ด "์๋ก์ด ์ฝ๋์ ์ปค๋ฒ๋ฆฌ์ง๊ฐ 80% ์ด์์ด์ด์ผ ํ๋ค"๊ฑฐ๋ "์ฌ๊ฐํ ๋ฒ๊ทธ๊ฐ 0๊ฐ์ฌ์ผ ํ๋ค"๋ ์์ ๊ท์น์ ์ค์ ํ ์ ์์ด. ์ด๊ฒ ์ ๋ง ๊ฐ๋ ฅํ ๊ธฐ๋ฅ์ด์ผ! ๐ช
3. ๊ธฐ์ ๋ถ์ฑ ์ธก์ (Technical Debt)
์ฝ๋์ ๋ฌธ์ ๋ฅผ ์์ ํ๋ ๋ฐ ๊ฑธ๋ฆด ์๊ฐ์ ์ถ์ ํด์ "๊ธฐ์ ๋ถ์ฑ"๋ก ํํํด. ์๋ฅผ ๋ค์ด "์ด ํ๋ก์ ํธ์ ๊ธฐ์ ๋ถ์ฑ๋ 15์ผ"์ด๋ผ๊ณ ํ๋ฉด, ๋ชจ๋ ๋ฌธ์ ๋ฅผ ํด๊ฒฐํ๋ ๋ฐ 15์ผ์ด ๊ฑธ๋ฆฐ๋ค๋ ์๋ฏธ์ผ. ์ด๊ฑธ ํตํด ํ๋ก์ ํธ์ ๊ฑด๊ฐ๋๋ฅผ ํ๋์ ํ์ ํ ์ ์์ด.
4. ๋ณด์ ์ทจ์ฝ์ ํ์ง (Security Hotspots)
OWASP Top 10, CWE Top 25 ๊ฐ์ ์ฃผ์ ๋ณด์ ์ทจ์ฝ์ ์ ์๋์ผ๋ก ํ์งํด. SQL ์ธ์ ์ , XSS, ํ๋์ฝ๋ฉ๋ ํฌ๋ ๋ด์ , ์ฝํ ์ํธํ ๋ฑ์ ์ฐพ์๋ด๊ณ , ๊ฐ ์ทจ์ฝ์ ์ ๋ํ ์ค๋ช ๊ณผ ํด๊ฒฐ ๋ฐฉ๋ฒ๊น์ง ์ ๊ณตํด์ค. ๐
5. ์ฝ๋ ์ค๋ณต ํ์ง (Duplication Detection)
ํ๋ก์ ํธ ๋ด์์ ์ค๋ณต๋ ์ฝ๋ ๋ธ๋ก์ ์ฐพ์๋ด. ์ฌ์ง์ด ์์ ํ ๋๊ฐ์ง ์์๋ ์ ์ฌํ ํจํด์ ๊ฐ์ง ์ฝ๋๊น์ง ํ์งํ ์ ์์ด. ์ค๋ณต ์ฝ๋๋ ์ ์ง๋ณด์์ ์ ์ด๋๊น, ์ด๊ฑธ ์ค์ด๋ ๊ฒ ์ ๋ง ์ค์ํด!
6. ์ฝ๋ ์ปค๋ฒ๋ฆฌ์ง ํตํฉ (Coverage Integration)
JaCoCo ๊ฐ์ ์ปค๋ฒ๋ฆฌ์ง ๋๊ตฌ์ ์ฐ๋ํด์ ํ ์คํธ ์ปค๋ฒ๋ฆฌ์ง๋ฅผ ์๊ฐํํด์ค. ์ด๋ค ๋ถ๋ถ์ด ํ ์คํธ๋์ง ์์๋์ง ํ๋์ ๋ณผ ์ ์์ด. ๐
๋ฐฉ๋ฒ 1: Docker๋ฅผ ์ด์ฉํ ์ค์น (์ถ์ฒ! ๐ณ)
Docker๊ฐ ์ค์น๋์ด ์๋ค๋ฉด ์ ๋ง ๊ฐ๋จํด. ๋จ ํ ์ค์ ๋ช ๋ น์ด๋ก SonarQube๋ฅผ ์คํํ ์ ์์ด:
docker run -d --name sonarqube -p 9000:9000 sonarqube:latest
์ด๋ ๊ฒ ํ๋ฉด localhost:9000์ผ๋ก SonarQube์ ์ ์ํ ์ ์์ด. ์ด๊ธฐ ๋ก๊ทธ์ธ ์ ๋ณด๋ admin/admin์ด์ผ. ์ฒซ ๋ก๊ทธ์ธ ํ์๋ ๋ฐ๋์ ๋น๋ฐ๋ฒํธ๋ฅผ ๋ณ๊ฒฝํด์ผ ํด! ๐๋ฐฉ๋ฒ 2: ์ง์ ์ค์น
1. SonarQube ๊ณต์ ์ฌ์ดํธ์์ zip ํ์ผ ๋ค์ด๋ก๋
2. ์์ถ ํด์ ํ bin ๋๋ ํ ๋ฆฌ์ ์คํ ํ์ผ ์คํ
3. Windows: StartSonar.bat, Linux/Mac: sonar.sh start
โข ํ๋ก๋์ ํ๊ฒฝ์์๋ PostgreSQL์ด๋ Oracle DB ์ฌ์ฉ ๊ถ์ฅ (H2๋ ๊ฐ๋ฐ์ฉ)
โข ์ต์ 2GB RAM ํ์, 4GB ์ด์ ๊ถ์ฅ
โข Elasticsearch๊ฐ ๋ด์ฅ๋์ด ์์ด์ ํฌํธ 9001๋ ์ฌ์ฉํจ
์ง์ ์๋ฒ๋ฅผ ๊ด๋ฆฌํ๊ธฐ ์ซ๋ค๋ฉด SonarCloud๋ผ๋ ํด๋ผ์ฐ๋ ์๋น์ค๋ฅผ ์ฌ์ฉํ ์๋ ์์ด. ์คํ์์ค ํ๋ก์ ํธ๋ ๋ฌด๋ฃ๋ก ์ฌ์ฉํ ์ ์๊ณ , GitHub, GitLab, Bitbucket๊ณผ ์ฝ๊ฒ ์ฐ๋๋ผ. โ๏ธ
Maven ํ๋ก์ ํธ ์ค์ :
pom.xml์ SonarQube ํ๋ฌ๊ทธ์ธ์ ์ถ๊ฐํ ํ์๋ ์์ด. Maven 3.x ์ด์์ด๋ฉด ๋ฐ๋ก ์ฌ์ฉ ๊ฐ๋ฅํด:
mvn clean verify sonar:sonar \
-Dsonar.projectKey=my-project \
-Dsonar.host.url=http://localhost:9000 \
-Dsonar.login=your-token-here
Gradle ํ๋ก์ ํธ ์ค์ :build.gradle์ ํ๋ฌ๊ทธ์ธ ์ถ๊ฐ:
plugins {
id "org.sonarqube" version "3.5.0.2730"
}
sonarqube {
properties {
property "sonar.projectKey", "my-project"
property "sonar.host.url", "http://localhost:9000"
property "sonar.login", "your-token-here"
}
}
๊ทธ๋ฆฌ๊ณ ์คํ:./gradlew sonarqube
2. ์ฐ์ธก ์๋จ ํ๋กํ โ My Account โ Security
3. Generate Token ํด๋ฆญ
4. ํ ํฐ ์ด๋ฆ ์ ๋ ฅํ๊ณ ์์ฑ
5. ์์ฑ๋ ํ ํฐ์ ๋ณต์ฌํด์ ์ฌ์ฉ (๋ค์ ๋ณผ ์ ์์ผ๋ ์ฃผ์!)
๋ถ์์ด ์๋ฃ๋๋ฉด SonarQube ๋์๋ณด๋์์ ๊ฒฐ๊ณผ๋ฅผ ๋ณผ ์ ์์ด. ์ฃผ์ ๋ฉํธ๋ฆญ๋ค์ ์ดํด๋ณผ๊น?
1. Bugs (๋ฒ๊ทธ)
์ค์ ๋ฒ๊ทธ๋ก ์ด์ด์ง ๊ฐ๋ฅ์ฑ์ด ๋์ ์ฝ๋. Blocker, Critical, Major, Minor๋ก ์ฌ๊ฐ๋๊ฐ ๋ถ๋ฅ๋ผ. Blocker์ Critical์ ๋ฐ๋์ ์์ ํด์ผ ํด! ๐
2. Vulnerabilities (์ทจ์ฝ์ )
๋ณด์ ์ทจ์ฝ์ . ์ด๊ฒ๋ ์ฌ๊ฐ๋๋ณ๋ก ๋ถ๋ฅ๋๋ฉฐ, ํนํ Critical ์ด์์ ์ฆ์ ์์ ์ด ํ์ํด. ํด์ปค๋ค์ด ๋ ธ๋ฆฌ๋ ๋ถ๋ถ์ด๊ฑฐ๋ ! ๐
3. Code Smells (์ฝ๋ ์ค๋ฉ)
๋น์ฅ ๋ฌธ์ ๋ ์๋์ง๋ง ์ ์ง๋ณด์์ฑ์ ํด์น๋ ์ฝ๋. ๋ณต์ก๋๊ฐ ๋๊ฑฐ๋, ์ค๋ณต์ด ๋ง๊ฑฐ๋, ๋ค์ด๋ฐ์ด ๋ถ๋ช ํํ ๊ฒฝ์ฐ ๋ฑ์ด์ผ. ์๊ฐ์ด ๋ ๋ ์กฐ๊ธ์ฉ ๊ฐ์ ํ๋ฉด ์ข์.
4. Coverage (์ปค๋ฒ๋ฆฌ์ง)
ํ ์คํธ ์ปค๋ฒ๋ฆฌ์ง ๋น์จ. 80% ์ด์์ ๋ชฉํ๋ก ํ๋ ๊ฒ ์ผ๋ฐ์ ์ด์ผ. ๋ฌผ๋ก 100%๊ฐ ํญ์ ์ข์ ๊ฑด ์๋์ง๋ง, ๋๋ฌด ๋ฎ์ผ๋ฉด ๋ฌธ์ ๊ฐ ์๋ค๋ ์ ํธ์ผ. ๐
5. Duplications (์ค๋ณต)
์ค๋ณต๋ ์ฝ๋์ ๋น์จ. 5% ์ดํ๋ก ์ ์งํ๋ ๊ฒ ์ข์. ์ค๋ณต์ด ๋ง์ผ๋ฉด ๊ฐ์ ๋ฒ๊ทธ๋ฅผ ์ฌ๋ฌ ๊ณณ์์ ๊ณ ์ณ์ผ ํ๋๊น ๋นํจ์จ์ ์ด์ง.
6. Maintainability Rating (์ ์ง๋ณด์์ฑ ๋ฑ๊ธ)
A๋ถํฐ E๊น์ง์ ๋ฑ๊ธ์ผ๋ก ํ์. A๊ฐ ์ต๊ณ ์ผ. ๊ธฐ์ ๋ถ์ฑ ๋น์จ์ ๋ฐ๋ผ ๊ฒฐ์ ๋ผ. A ๋ฑ๊ธ์ ์ ์งํ๋ ๊ฒ ๋ชฉํ!
7. Reliability Rating (์ ๋ขฐ์ฑ ๋ฑ๊ธ)
๋ฒ๊ทธ์ ์ฌ๊ฐ๋์ ๊ฐ์์ ๋ฐ๋ผ ๊ฒฐ์ . A ๋ฑ๊ธ์ ๋ฒ๊ทธ๊ฐ ์๊ฑฐ๋ Minor๋ง ์๋ ์ํ์ผ.
8. Security Rating (๋ณด์ ๋ฑ๊ธ)
๋ณด์ ์ทจ์ฝ์ ์ ๋ฐ๋ผ ๊ฒฐ์ . ๋น์ฐํ A ๋ฑ๊ธ์ ๋ชฉํ๋ก ํด์ผ์ง! ๐ฏ
Quality Profile ์์ฑ ๋ฐฉ๋ฒ:
1. Quality Profiles ๋ฉ๋ด๋ก ์ด๋
2. ๊ธฐ๋ณธ ํ๋กํ(Sonar way)์ ๋ณต์ฌํด์ ์ ํ๋กํ ์์ฑ
3. ๊ท์น์ ์ถ๊ฐ/์ ๊ฑฐํ๊ฑฐ๋ ์ฌ๊ฐ๋ ๋ณ๊ฒฝ
4. ํ๋ก์ ํธ์ ํด๋น ํ๋กํ ์ ์ฉ
์๋ฅผ ๋ค์ด, ์ฐ๋ฆฌ ํ์ ๋ฉ์๋ ๊ธธ์ด๋ฅผ 50์ค๋ก ์ ํํ๊ณ ์ถ๋ค๋ฉด "Methods should not have too many lines" ๊ท์น์ ํ๋ผ๋ฏธํฐ๋ฅผ 50์ผ๋ก ์ค์ ํ๋ฉด ๋ผ. ์ด๋ฐ ์์ผ๋ก ํ์ ์ฝ๋ฉ ํ์ค์ ๋ง๊ฒ ์กฐ์ ํ ์ ์์ด! ๐ฏ
์์ฃผ ์ปค์คํฐ๋ง์ด์งํ๋ ๊ท์น๋ค:
โข ์ํ ๋ณต์ก๋ ์๊ณ๊ฐ (๊ธฐ๋ณธ: 10)
โข ๋ฉ์๋ ๊ธธ์ด ์ ํ (๊ธฐ๋ณธ: 100์ค)
โข ํด๋์ค ๊ธธ์ด ์ ํ (๊ธฐ๋ณธ: 1000์ค)
โข ํ๋ผ๋ฏธํฐ ๊ฐ์ ์ ํ (๊ธฐ๋ณธ: 7๊ฐ)
โข ๋ค์ด๋ฐ ์ปจ๋ฒค์ (camelCase, PascalCase ๋ฑ)
โข ์ฃผ์ ๋ฐ๋ (์ต์ 25%)
Jenkins ํตํฉ ์์:
pipeline {
agent any
stages {
stage('Build') {
steps {
sh 'mvn clean package'
}
}
stage('SonarQube Analysis') {
steps {
withSonarQubeEnv('SonarQube Server') {
sh 'mvn sonar:sonar'
}
}
}
stage('Quality Gate') {
steps {
timeout(time: 1, unit: 'HOURS') {
waitForQualityGate abortPipeline: true
}
}
}
}
}
์ด๋ ๊ฒ ์ค์ ํ๋ฉด ํ์ง ๊ฒ์ดํธ๋ฅผ ํต๊ณผํ์ง ๋ชปํ ์ฝ๋๋ ์ ๋ ๋ฐฐํฌ๋์ง ์์. ์์ ์ฅ์น๊ฐ ํ๋ ๋ ์๊ธฐ๋ ์
์ด์ง! ๐ก๏ธGitHub Actions ํตํฉ ์์:
name: SonarQube Analysis
on:
push:
branches: [ main, develop ]
pull_request:
branches: [ main ]
jobs:
sonarqube:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Set up JDK 11
uses: actions/setup-java@v2
with:
java-version: '11'
distribution: 'adopt'
- name: Cache SonarQube packages
uses: actions/cache@v2
with:
path: ~/.sonar/cache
key: ${{ runner.os }}-sonar
- name: Build and analyze
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
run: mvn -B verify sonar:sonar
GitHub Actions๋ฅผ ์ฌ์ฉํ๋ฉด Pull Request๋ง๋ค ์๋์ผ๋ก ๋ถ์์ด ์คํ๋๊ณ , PR์ ์ฝ๋ฉํธ๋ก ๊ฒฐ๊ณผ๊ฐ ๋ฌ๋ ค. ๋ฆฌ๋ทฐ์ด๊ฐ ์ฝ๋ ํ์ง์ ํ๋์ ํ์ธํ ์ ์์ด์ ์ ๋ง ํธํด! ๐
SpotBugs์ ํน์ง:
1. ๋ฐ์ดํธ์ฝ๋ ๋ถ์
์์ค ์ฝ๋๊ฐ ์๋๋ผ ์ปดํ์ผ๋ .class ํ์ผ์ ๋ถ์ํด. ์ด๊ฒ ์ฅ์ ์ด์ ๋จ์ ์ธ๋ฐ, ์์ค ์ฝ๋ ์์ด๋ ๋ถ์ํ ์ ์์ง๋ง, ์์ค ์ฝ๋ ๋ ๋ฒจ์ ์ ๋ณด๋ ์ ํ์ ์ด์ผ.
2. ๋ฒ๊ทธ ํจํด ๋งค์นญ
400๊ฐ ์ด์์ ๋ฒ๊ทธ ํจํด์ ๊ฐ์ง๊ณ ์์ด. ๊ฐ ํจํด์ ์ค์ ๋ก ์์ฃผ ๋ฐ์ํ๋ ๋ฒ๊ทธ๋ค์ ๊ธฐ๋ฐ์ผ๋ก ๋ง๋ค์ด์ก์ด. Null Pointer Exception, ๋ฆฌ์์ค ๋์, ๋๊ธฐํ ๋ฌธ์ ๋ฑ์ ์ ์ฐพ์๋ด์ง. ๐ฏ
3. ๋น ๋ฅธ ๋ถ์ ์๋
๋ฐ์ดํธ์ฝ๋๋ฅผ ๋ถ์ํ๊ธฐ ๋๋ฌธ์ ์๋์ ์ผ๋ก ๋น ๋ฅธ ํธ์ด์ผ. ๋๊ท๋ชจ ํ๋ก์ ํธ๋ ๋ช ๋ถ ์์ ๋ถ์ํ ์ ์์ด.
4. IDE ํตํฉ
Eclipse, IntelliJ IDEA, VS Code ๋ฑ ์ฃผ์ IDE์ ํ๋ฌ๊ทธ์ธ์ด ์์ด. ์ฝ๋ฉํ๋ฉด์ ์ค์๊ฐ์ผ๋ก ๋ฌธ์ ๋ฅผ ํ์ธํ ์ ์์ง.
5. ํ๋ฌ๊ทธ์ธ ์์คํ
fb-contrib, Find Security Bugs ๊ฐ์ ์ถ๊ฐ ํ๋ฌ๊ทธ์ธ์ ์ค์นํด์ ๋ ๋ง์ ๋ฒ๊ทธ ํจํด์ ํ์งํ ์ ์์ด. ํนํ Find Security Bugs๋ ๋ณด์ ์ทจ์ฝ์ ํ์ง์ ํนํ๋์ด ์์ด. ๐
Maven ํ๋ก์ ํธ ์ค์ :
pom.xml์ SpotBugs ํ๋ฌ๊ทธ์ธ ์ถ๊ฐ:
<build>
<plugins>
<plugin>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<version>4.7.3.0</version>
<configuration>
<effort>Max</effort>
<threshold>Low</threshold>
<xmlOutput>true</xmlOutput>
<plugins>
<plugin>
<groupId>com.h3xstream.findsecbugs</groupId>
<artifactId>findsecbugs-plugin</artifactId>
<version>1.12.0</version>
</plugin>
</plugins>
</configuration>
</plugin>
</plugins>
</build>
์คํ ๋ช
๋ น์ด:mvn spotbugs:check
Gradle ํ๋ก์ ํธ ์ค์ :build.gradle์ ํ๋ฌ๊ทธ์ธ ์ถ๊ฐ:
plugins {
id 'com.github.spotbugs' version '5.0.13'
}
spotbugs {
effort = 'max'
reportLevel = 'low'
excludeFilter = file("spotbugs-exclude.xml")
}
spotbugsMain {
reports {
html {
enabled = true
destination = file("$buildDir/reports/spotbugs/main/spotbugs.html")
}
xml {
enabled = true
destination = file("$buildDir/reports/spotbugs/main/spotbugs.xml")
}
}
}
dependencies {
spotbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:1.12.0'
}
์คํ ๋ช
๋ น์ด:./gradlew spotbugsMain
โข threshold/reportLevel: ๋ณด๊ณ ํ ๋ฒ๊ทธ์ ์ต์ ์ฌ๊ฐ๋ (High, Medium, Low). Low๋ก ์ค์ ํ๋ฉด ๋ชจ๋ ๋ฒ๊ทธ๋ฅผ ๋ณด๊ณ ํด.
โข excludeFilter: ํน์ ํ์ผ์ด๋ ๋ฒ๊ทธ ํจํด์ ์ ์ธํ ์ ์์ด. ๊ฑฐ์ง ์์ฑ(False Positive)์ ์ค์ด๋ ๋ฐ ์ ์ฉํด.
<FindBugsFilter>
<!-- ํ
์คํธ ์ฝ๋ ์ ์ธ -->
<Match>
<Class name="~.*Test$" />
</Match>
<!-- ํน์ ๋ฒ๊ทธ ํจํด ์ ์ธ -->
<Match>
<Bug pattern="EI_EXPOSE_REP" />
</Match>
<!-- ํน์ ํด๋์ค์ ํน์ ๋ฉ์๋ ์ ์ธ -->
<Match>
<Class name="com.example.MyClass" />
<Method name="getLegacyData" />
</Match>
</FindBugsFilter>
๋ ๊ฑฐ์ ์ฝ๋๋ ์ธ๋ถ ๋ผ์ด๋ธ๋ฌ๋ฆฌ ๊ฐ์ด ์์ ํ ์ ์๋ ์ฝ๋๋ ์ ์ธํ๋ ๊ฒ ์ข์. ๊ทธ๋์ผ ์ค์ ๋ก ์์ ํด์ผ ํ ์ด์์ ์ง์คํ ์ ์๊ฑฐ๋ ! ๐ฏ
1. Correctness (์ ํ์ฑ) ๐ฏ
ํ๋ก๊ทธ๋จ์ ๋ ผ๋ฆฌ์ ์ค๋ฅ๋ฅผ ์ฐพ์๋ด๋ ์นดํ ๊ณ ๋ฆฌ์ผ. ๊ฐ์ฅ ์ฌ๊ฐํ ๋ฒ๊ทธ๋ค์ด ์ฌ๊ธฐ ์ํด.
public String getUserName(User user) {
// user๊ฐ null์ผ ์ ์๋๋ฐ ์ฒดํฌํ์ง ์์!
return user.getName(); // ๐ฅ NPE ๋ฐ์ ๊ฐ๋ฅ
}
ํด๊ฒฐ ๋ฐฉ๋ฒ:public String getUserName(User user) {
if (user == null) {
return "Unknown";
}
return user.getName();
// ๋๋ Optional ์ฌ์ฉ
return Optional.ofNullable(user)
.map(User::getName)
.orElse("Unknown");
}
String text = "Hello";
if (text != null) { // ๋ถํ์ํ ์ฒดํฌ
System.out.println(text);
}
์ด๊ฑด ๋ฒ๊ทธ๋ ์๋์ง๋ง ์ฝ๋๋ฅผ ๋ณต์กํ๊ฒ ๋ง๋ค์ด. ๋ช
๋ฐฑํ null์ด ์๋ ๊ฐ์ ์ฒดํฌํ๋ ๊ฑด ์๋ฏธ ์์ง.
String query = "SELECT * FROM users WHERE name = '" + userName + "'";
Statement stmt = conn.createStatement();
ResultSet rs = stmt.executeQuery(query); // ๐จ SQL ์ธ์ ์
์ํ!
ํด๊ฒฐ ๋ฐฉ๋ฒ:String query = "SELECT * FROM users WHERE name = ?";
PreparedStatement pstmt = conn.prepareStatement(query);
pstmt.setString(1, userName); // ์์ ํ๊ฒ ํ๋ผ๋ฏธํฐ ๋ฐ์ธ๋ฉ
ResultSet rs = pstmt.executeQuery();
๊ธฐ์ ์ ์ผ๋ก๋ ๋์ํ์ง๋ง ๊ถ์ฅ๋์ง ์๋ ์ฝ๋ฉ ํจํด๋ค์ด์ผ.
public class Person implements Comparable<Person> {
private String name;
@Override
public int compareTo(Person other) {
return this.name.compareTo(other.name);
}
// equals๋ฅผ ์ค๋ฒ๋ผ์ด๋ํ์ง ์์!
// compareTo์ equals๊ฐ ์ผ๊ด์ฑ์ด ์์
}
ํด๊ฒฐ ๋ฐฉ๋ฒ:@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (!(obj instanceof Person)) return false;
Person other = (Person) obj;
return Objects.equals(name, other.name);
}
@Override
public int hashCode() {
return Objects.hash(name);
}
public void readFile(String path) throws IOException {
FileInputStream fis = new FileInputStream(path);
// ํ์ผ์ ์ฝ๋ ์ฝ๋...
// fis.close()๋ฅผ ํธ์ถํ์ง ์์! ๐ง ๋ฆฌ์์ค ๋์
}
ํด๊ฒฐ ๋ฐฉ๋ฒ:public void readFile(String path) throws IOException {
try (FileInputStream fis = new FileInputStream(path)) {
// ํ์ผ์ ์ฝ๋ ์ฝ๋...
} // try-with-resources๋ก ์๋์ผ๋ก close() ํธ์ถ
}
์ฑ๋ฅ์ ์ํฅ์ ์ค ์ ์๋ ๋นํจ์จ์ ์ธ ์ฝ๋ ํจํด๋ค์ด์ผ.
public class Outer {
private int value;
// ๋ด๋ถ ํด๋์ค๊ฐ ์ธ๋ถ ํด๋์ค์ ๋ฉค๋ฒ๋ฅผ ์ฌ์ฉํ์ง ์๋๋ฐ๋
// static์ด ์๋ โ ๋ถํ์ํ ๋ฉ๋ชจ๋ฆฌ ์ฌ์ฉ
class Inner {
void doSomething() {
System.out.println("Hello");
}
}
}
ํด๊ฒฐ ๋ฐฉ๋ฒ:static class Inner {
void doSomething() {
System.out.println("Hello");
}
}
String result = "";
for (int i = 0; i < 1000; i++) {
result += i; // ๋งค๋ฒ ์๋ก์ด String ๊ฐ์ฒด ์์ฑ! ๐ฑ
}
ํด๊ฒฐ ๋ฐฉ๋ฒ:StringBuilder sb = new StringBuilder();
for (int i = 0; i < 1000; i++) {
sb.append(i);
}
String result = sb.toString();
๋์์ฑ ํ๋ก๊ทธ๋๋ฐ์์ ๋ฐ์ํ ์ ์๋ ๋ฌธ์ ๋ค์ ์ฐพ์๋ด.
public class Counter {
private int count = 0;
public synchronized void increment() {
count++;
}
public int getCount() { // ๋๊ธฐํ๋์ง ์์!
return count; // ๐ฅ Race Condition ๊ฐ๋ฅ
}
}
ํด๊ฒฐ ๋ฐฉ๋ฒ:public synchronized int getCount() {
return count;
}
// ๋๋ AtomicInteger ์ฌ์ฉ
private AtomicInteger count = new AtomicInteger(0);
public void increment() {
count.incrementAndGet();
}
public int getCount() {
return count.get();
}
๋ช ๋ฐฑํ ๋ฒ๊ทธ๋ ์๋์ง๋ง ์๋ํ์ง ์์ ๋์์ ํ ๊ฐ๋ฅ์ฑ์ด ์๋ ์ฝ๋์ผ.
String text = " hello ";
text.trim(); // trim()์ ๋ฐํ๊ฐ์ ์ฌ์ฉํ์ง ์์!
System.out.println(text); // ์ฌ์ ํ " hello " ์ถ๋ ฅ
ํด๊ฒฐ ๋ฐฉ๋ฒ:String text = " hello ";
text = text.trim(); // ๋ฐํ๊ฐ์ ์ ์ฅ
System.out.println(text); // "hello" ์ถ๋ ฅ
IntelliJ IDEA ํ๋ฌ๊ทธ์ธ:
1. Settings โ Plugins โ Marketplace
2. "SpotBugs" ๊ฒ์ ํ ์ค์น
3. ์ฌ์์ ํ Analyze โ Analyze Code with SpotBugs
ํ๋ฌ๊ทธ์ธ์ ์ค์นํ๋ฉด ์๋ํฐ์์ ๋ฐ๋ก ๊ฒฝ๊ณ ๊ฐ ํ์๋ผ. ๋ง์ฐ์ค๋ฅผ ์ฌ๋ฆฌ๋ฉด ์์ธํ ์ค๋ช ๊ณผ ํด๊ฒฐ ๋ฐฉ๋ฒ๊น์ง ๋ณผ ์ ์์ด. ์ฝ๋ ๋ฆฌ๋ทฐ ์ ์ ๋ฏธ๋ฆฌ ๋ฌธ์ ๋ฅผ ์์ ํ ์ ์์ด์ ์ ๋ง ์ ์ฉํด! ๐
Eclipse ํ๋ฌ๊ทธ์ธ:
1. Help โ Eclipse Marketplace
2. "SpotBugs" ๊ฒ์ ํ ์ค์น
3. Window โ Show View โ Other โ SpotBugs
VS Code ํ์ฅ:
VS Code์์๋ ์ง์ ์ ์ธ SpotBugs ํ์ฅ์ ์์ง๋ง, SonarLint ํ์ฅ์ ์ฌ์ฉํ๋ฉด ์ ์ฌํ ๊ธฐ๋ฅ์ ์ฌ์ฉํ ์ ์์ด. SonarLint๋ SonarQube์ ๊ท์น์ IDE์์ ์ค์๊ฐ์ผ๋ก ์ฒดํฌํด์ฃผ๊ฑฐ๋ .
โข SpotBugs IDE ํ๋ฌ๊ทธ์ธ์ผ๋ก ์ค์๊ฐ ์ฒดํฌ
โข ์ฝ๋ฉํ๋ฉด์ ์ฆ์ ๋ฌธ์ ๋ฐ๊ฒฌ ๋ฐ ์์
โข ๋น ๋ฅธ ํผ๋๋ฐฑ ๋ฃจํ ํ์ฑ
์ปค๋ฐ ์ (๋ก์ปฌ):
โข SpotBugs ๋น๋ ํ๋ฌ๊ทธ์ธ์ผ๋ก ์ ์ฒด ๊ฒ์ฌ
โข ์ฌ๊ฐํ ๋ฒ๊ทธ๊ฐ ์๋์ง ํ์ธ
โข Git pre-commit hook ํ์ฉ ๊ฐ๋ฅ
Pull Request (CI):
โข SonarQube๋ก ์ข ํฉ ๋ถ์
โข ์ฝ๋ ์ปค๋ฒ๋ฆฌ์ง, ์ค๋ณต๋, ๋ณต์ก๋ ๋ฑ ์ ์ฒด ํ์ง ์งํ ํ์ธ
โข ํ์ง ๊ฒ์ดํธ ํต๊ณผ ์ฌ๋ถ ์ฒดํฌ
์ ๊ธฐ ์ ๊ฒ (์ฃผ๊ฐ/์๊ฐ):
โข SonarQube ๋์๋ณด๋๋ก ํธ๋ ๋ ๋ถ์
โข ๊ธฐ์ ๋ถ์ฑ ์ฆ๊ฐ ์ถ์ด ๋ชจ๋ํฐ๋ง
โข ํ ํ๊ณ ์ ํ์ง ์งํ ๋ฆฌ๋ทฐ
SonarQube์ SpotBugs๊ฐ ์ค๋ณต์ผ๋ก ๊ฐ์ ๋ฌธ์ ๋ฅผ ๋ณด๊ณ ํ ์ ์์ด. ์ด๋ด ๋๋ ํ๋์ ๋๊ตฌ์์๋ง ํด๋น ๊ท์น์ ํ์ฑํํ๋ ๊ฒ ์ข์. ์ค๋ณต ๊ฒฝ๊ณ ๋ ์คํ๋ ค ํผ๋์ ์ค ์ ์๊ฑฐ๋ .
์๋ฅผ ๋ค์ด:
โข Null ์ฒดํฌ ๊ด๋ จ: SonarQube์์๋ง ํ์ฑํ
โข ๋ฆฌ์์ค ๋์: SpotBugs์์๋ง ํ์ฑํ
โข ๋ณด์ ์ทจ์ฝ์ : ๋ ๋ค ํ์ฑํ (์ค์ํ๋๊น!)
3. ์ ์ง์ ๊ฐ์
๋ ๊ฑฐ์ ํ๋ก์ ํธ์ ์ ์ ๋ถ์์ ๋์ ํ ๋๋ ํ ๋ฒ์ ๋ชจ๋ ์ด์๋ฅผ ํด๊ฒฐํ๋ ค๊ณ ํ๋ฉด ์ ๋ผ. ์์ฒ ๊ฐ์ ๊ฒฝ๊ณ ๊ฐ ๋์ฌ ์ ์๊ฑฐ๋ ! ๐ฑ
์ถ์ฒํ๋ ์ ๊ทผ ๋ฐฉ๋ฒ:
โข Blocker, Critical ๋ฑ๊ธ๋ง ๋จผ์ ํด๊ฒฐ
โข Null Pointer Exception, ๋ณด์ ์ทจ์ฝ์ ๋ฑ
โข ๋ชฉํ: 1~2์ฃผ ๋ด ์๋ฃ
2๋จ๊ณ: ์ ์ฝ๋์ ์๊ฒฉํ ๊ธฐ์ค ์ ์ฉ
โข ํ์ง ๊ฒ์ดํธ๋ฅผ "New Code" ๊ธฐ์ค์ผ๋ก ์ค์
โข ์๋ก ์์ฑํ๋ ์ฝ๋๋ ๋์ ํ์ง ์ ์ง
โข ๊ธฐ์กด ์ฝ๋๋ ์ ์ง์ ์ผ๋ก ๊ฐ์
3๋จ๊ณ: ๊ธฐ์ ๋ถ์ฑ ์ํ ๊ณํ
โข ๋งค ์คํ๋ฆฐํธ๋ง๋ค ์ผ์ ์๊ฐ์ ๊ธฐ์ ๋ถ์ฑ ํด๊ฒฐ์ ํ ๋น
โข ์ฐ์ ์์๊ฐ ๋์ ๋ชจ๋๋ถํฐ ๋ฆฌํฉํ ๋ง
โข ๋ชฉํ: 6๊ฐ์~1๋ ๋ด ์ฃผ์ ์ด์ ํด๊ฒฐ
์ฌ๋ก 1: ์คํํธ์ A์ฌ
์ด๊ธฐ์๋ ๋น ๋ฅธ ๊ฐ๋ฐ์๋ง ์ง์คํ๋ค๊ฐ ๋ฒ๊ทธ๊ฐ ๋๋ฌด ๋ง์์ ธ์ ์ ์ ๋ถ์์ ๋์ ํ์ด.
โข ํซํฝ์ค ๋ฐฐํฌ: ์ฃผ 2~3ํ
โข ์ฝ๋ ๋ฆฌ๋ทฐ ์๊ฐ: PR๋น ํ๊ท 2์๊ฐ
โข ๊ฐ๋ฐ์ ๋ง์กฑ๋: ๋ฎ์ ๐
๋์ ํ (6๊ฐ์):
โข ์ฃผ๊ฐ ๋ฒ๊ทธ ๋ฆฌํฌํธ: ํ๊ท 3๊ฑด (80% ๊ฐ์!)
โข ํซํฝ์ค ๋ฐฐํฌ: ์ 1~2ํ
โข ์ฝ๋ ๋ฆฌ๋ทฐ ์๊ฐ: PR๋น ํ๊ท 30๋ถ
โข ๊ฐ๋ฐ์ ๋ง์กฑ๋: ๋์ ๐
ํต์ฌ ์ ๋ต:
โข Jenkins ํ์ดํ๋ผ์ธ์ SonarQube ํตํฉ
โข ํ์ง ๊ฒ์ดํธ ํต๊ณผ ํ์
โข ๋งค์ฃผ ๊ธ์์ผ ์คํ๋ฅผ "๊ธฐ์ ๋ถ์ฑ ์ํ์ ๋ "๋ก ์ง์
โข ์ฝ๋ ํ์ง ๊ฐ์ ์ KPI์ ํฌํจ
10๋ ์ด์ ๋ ๋ ๊ฑฐ์ ์์คํ ์ ์ ์ ๋ถ์์ ๋์ ํ ์ผ์ด์ค์ผ.
โข Blocker: 234๊ฑด
โข Critical: 1,456๊ฑด
โข ๊ธฐ์ ๋ถ์ฑ: ์ฝ 180์ผ
โข ์ฝ๋ ์ปค๋ฒ๋ฆฌ์ง: 23%
1๋ ํ:
โข ์ด ์ด์: 2,341๊ฑด (82% ๊ฐ์)
โข Blocker: 0๊ฑด โ
โข Critical: 12๊ฑด
โข ๊ธฐ์ ๋ถ์ฑ: ์ฝ 35์ผ
โข ์ฝ๋ ์ปค๋ฒ๋ฆฌ์ง: 67%
ํต์ฌ ์ ๋ต:
โข ๋ชจ๋๋ณ๋ก ์ฐ์ ์์ ์ค์ (ํต์ฌ ๋น์ฆ๋์ค ๋ก์ง ์ฐ์ )
โข ๊ฐ ํ์ "ํ์ง ์ฑํผ์ธ" ์ง์
โข ์๊ฐ ์ฝ๋ ํ์ง ๋ฆฌํฌํธ๋ฅผ ๊ฒฝ์์ง์ ๋ณด๊ณ
โข ํ์ง ๊ฐ์ ์ฐ์ ํ์ ์ธ์ผํฐ๋ธ ์ ๊ณต
GitHub์์ ์ด์๋๋ ์ธ๊ธฐ ์คํ์์ค ํ๋ก์ ํธ์ ์ฌ๋ก์ผ.
โข ๋ฒ๊ทธ ๋ฆฌํฌํธ๊ฐ ์ฆ๊ฐํ๋ ์ถ์ธ
โข ๋ฉ์ธํ ์ด๋์ ๋ฆฌ๋ทฐ ๋ถ๋ด ๊ณผ์ค
ํด๊ฒฐ ๋ฐฉ๋ฒ:
โข SonarCloud(๋ฌด๋ฃ) ์ฐ๋
โข GitHub Actions๋ก PR๋ง๋ค ์๋ ๋ถ์
โข ํ์ง ๊ฒ์ดํธ ํต๊ณผ ํ์
โข ์ปจํธ๋ฆฌ๋ทฐ์ ๊ฐ์ด๋์ ์ฝ๋ ํ์ง ๊ธฐ์ค ๋ช ์
๊ฒฐ๊ณผ:
โข PR ํ์ง ํฅ์ (์ฒซ ๋ฆฌ๋ทฐ์์ ์น์ธ๋๋ ๋น์จ ์ฆ๊ฐ)
โข ๋ฉ์ธํ ์ด๋์ ๋ฆฌ๋ทฐ ์๊ฐ 50% ๊ฐ์
โข ๋ฒ๊ทธ ๋ฐ์๋ฅ ๊ฐ์
โข ์ปจํธ๋ฆฌ๋ทฐํฐ๋ค์ ์ฝ๋ฉ ์ค๋ ฅ ํฅ์ ํจ๊ณผ
์ ์ ๋ถ์ ๋๊ตฌ๋ฅผ ๋์ ํ๋ ค๋ฉด ํ ์ ์ฒด์ ๋์๊ฐ ํ์ํด. ์ผ๋ถ ๊ฐ๋ฐ์๋ค์ "๊ท์ฐฎ์ ๊ท์น"์ด๋ผ๊ณ ์๊ฐํ ์ ์๊ฑฐ๋ . ์ด๋ด ๋๋:
โข ์ค์ ๋ฒ๊ทธ ์ฌ๋ก๋ฅผ ๋ณด์ฌ์ฃผ๋ฉฐ ํ์์ฑ ์ค๋ช
โข ํ์ผ๋ฟ ํ๋ก์ ํธ๋ก ํจ๊ณผ ์ ์ฆ
โข ์ ์ง์ ๋์ ์ผ๋ก ๋ถ๋ด ์ต์ํ
โข ๊ฐ์ ํจ๊ณผ๋ฅผ ์ ๋์ ์ผ๋ก ์ธก์ ํ๊ณ ๊ณต์
2. ํ์ค์ ์ธ ๊ธฐ์ค ์ค์
์ฒ์๋ถํฐ ๋๋ฌด ์๊ฒฉํ ๊ธฐ์ค์ ์ ์ฉํ๋ฉด ๊ฐ๋ฐ ์๋๊ฐ ๋๋ ค์ง๊ณ ํ์๋ค์ ๋ฐ๋ฐ์ ์ด ์ ์์ด. ํ์ค์ ์ธ ๊ธฐ์ค์ ์ค์ ํ๊ณ ์ ์ง์ ์ผ๋ก ๋์ฌ๊ฐ๋ ๊ฒ ์ข์.
โข ์ ์ฝ๋์ Blocker/Critical ๋ฒ๊ทธ: 0๊ฐ
โข ์ ์ฝ๋์ ์ปค๋ฒ๋ฆฌ์ง: 60% ์ด์
โข ์ ์ฝ๋์ ์ค๋ณต๋: 5% ์ดํ
6๊ฐ์ ํ ๊ฐํ:
โข ์ ์ฝ๋์ Major ๋ฒ๊ทธ: 0๊ฐ
โข ์ ์ฝ๋์ ์ปค๋ฒ๋ฆฌ์ง: 80% ์ด์
โข ์ ์ฝ๋์ ์ค๋ณต๋: 3% ์ดํ
โข ์ ์ฝ๋์ ๊ธฐ์ ๋ถ์ฑ ๋น์จ: 5% ์ดํ
์๋์ผ๋ก ๋ถ์์ ์คํํ๋ฉด ๊ท์ฐฎ์์ ์ ํ๊ฒ ๋ผ. ๋ฐ๋์ CI/CD ํ์ดํ๋ผ์ธ์ ํตํฉํด์ ์๋ํํด์ผ ํด! ๐ค
โข Git hook์ผ๋ก ์ปค๋ฐ ์ ๋ก์ปฌ ์ฒดํฌ
โข PR ์์ฑ ์ ์๋ ๋ถ์
โข ๋จธ์ง ์ ํ์ง ๊ฒ์ดํธ ์ฒดํฌ
โข ์ผ์ผ/์ฃผ๊ฐ ์ ๊ธฐ ๋ถ์ ๋ฐ ๋ฆฌํฌํธ
4. ๊ฑฐ์ง ์์ฑ ๊ด๋ฆฌ
์ ์ ๋ถ์ ๋๊ตฌ๋ ๋๋๋ก ์ค์ ๋ก๋ ๋ฌธ์ ๊ฐ ์๋ ์ฝ๋๋ฅผ ๋ฌธ์ ๋ผ๊ณ ๋ณด๊ณ ํด. ์ด๋ฐ ๊ฑฐ์ง ์์ฑ(False Positive)์ ๋ฐฉ์นํ๋ฉด "๋๋๊ฐ ๋ํ๋ฌ๋ค" ํจ๊ณผ๊ฐ ์๊ฒจ์ ์ง์ง ๋ฌธ์ ๋ฅผ ๋์น ์ ์์ด.
โข ๋ช ๋ฐฑํ ๊ฑฐ์ง ์์ฑ์ ์ ์ธ ํํฐ์ ์ถ๊ฐ
โข ๊ฐ ๊ฒฝ๊ณ ์ ๋ํ ํ๋จ ๊ธฐ์ค ๋ฌธ์ํ
โข ์ ๊ธฐ์ ์ผ๋ก ์ ์ธ ํํฐ ๋ฆฌ๋ทฐ
โข ๋๊ตฌ ์ ๋ฐ์ดํธ ์ ๊ฑฐ์ง ์์ฑ ์ฌํ์ธ
SonarQube์ SpotBugs ๋ชจ๋ ์ปค์คํ ๊ท์น์ ์์ฑํ ์ ์์ด. ํ์ด๋ ํ๋ก์ ํธ์ ํนํ๋ ๊ท์น์ ๋ง๋ค ์ ์์ง.
์๋ฅผ ๋ค์ด, ํ์ฌ์์ ํน์ ๋ผ์ด๋ธ๋ฌ๋ฆฌ์ ์ฌ์ฉ์ ๊ธ์งํ๋ค๋ฉด ๊ทธ๊ฑธ ์ฒดํฌํ๋ ๊ท์น์ ๋ง๋ค ์ ์์ด:
// SonarQube ์ปค์คํ
๊ท์น ์์ (Java)
@Rule(key = "ForbiddenLibraryUsage")
public class ForbiddenLibraryCheck extends BaseTreeVisitor implements JavaFileScanner {
@Override
public void visitImport(ImportTree tree) {
String importedClass = tree.qualifiedIdentifier().toString();
if (importedClass.startsWith("com.forbidden.library")) {
reportIssue(tree, "์ด ๋ผ์ด๋ธ๋ฌ๋ฆฌ๋ ์ฌ์ฉ์ด ๊ธ์ง๋์ด ์์ต๋๋ค.");
}
super.visitImport(tree);
}
}
2. ๋ฉํธ๋ฆญ ๊ธฐ๋ฐ ๋ฆฌํฉํ ๋งSonarQube์ ๋ฉํธ๋ฆญ์ ํ์ฉํด์ ๋ฆฌํฉํ ๋ง ์ฐ์ ์์๋ฅผ ์ ํ ์ ์์ด.
โข ๋ณต์ก๋ 15 ์ด์: ์ฆ์ ๋ฆฌํฉํ ๋ง ํ์
โข ๋ณต์ก๋ 10~14: ๋ค์ ์์ ์ ๋ฆฌํฉํ ๋ง
โข ๋ณต์ก๋ 10 ๋ฏธ๋ง: ์ํธ
์ธ์ง ๋ณต์ก๋(Cognitive Complexity)๊ฐ ๋์ ๋ฉ์๋:
โข ์ฌ๋์ด ์ดํดํ๊ธฐ ์ด๋ ค์ด ์ ๋๋ฅผ ์ธก์
โข ์ค์ฒฉ๋ if๋ฌธ, ๋ณต์กํ ๋ ผ๋ฆฌ ์ฐ์ฐ ๋ฑ
โข ์ํ ๋ณต์ก๋๋ณด๋ค ์ค์ ๊ฐ๋ ์ฑ์ ๋ ์ ๋ฐ์
๋ณด์์ด ์ค์ํ ํ๋ก์ ํธ๋ผ๋ฉด ๋ณด์ ๊ท์น์ ์ง์คํ ์ ์์ด.
โข Find Security Bugs ํ๋ฌ๊ทธ์ธ ํ์ฉ
โข OWASP Top 10 ๊ท์น ํ์ฑํ
โข ๋ณด์ ์ทจ์ฝ์ ์ Blocker๋ก ์ค์
โข ์ ๊ธฐ์ ์ธ ๋ณด์ ๊ฐ์ฌ ์ค์
4. ๊ธฐ์ ๋ถ์ฑ ์๊ฐํ
SonarQube์ ๊ธฐ์ ๋ถ์ฑ ๋ฉํธ๋ฆญ์ ํ์ฉํด์ ํ๋ก์ ํธ์ ๊ฑด๊ฐ๋๋ฅผ ์๊ฐํํ ์ ์์ด. ์ด๊ฑธ ๊ฒฝ์์ง์๊ฒ ๋ณด๊ณ ํ๋ฉด ๋ฆฌํฉํ ๋ง ์๊ฐ์ ํ๋ณดํ๋ ๋ฐ ๋์์ด ๋ผ! ๐
โข ๊ธฐ์ ๋ถ์ฑ ํธ๋ ๋ ๊ทธ๋ํ
โข ๋ชจ๋๋ณ ๊ธฐ์ ๋ถ์ฑ ๋น๊ต
โข ์ ๊ท ๊ฐ๋ฐ vs ๊ธฐ์ ๋ถ์ฑ ์ํ ๋น์จ
โข ROI(ํฌ์ ๋๋น ํจ๊ณผ) ๊ณ์ฐ
๊ณต์ ๋ฌธ์:
โข SonarQube Documentation: docs.sonarqube.org
โข SpotBugs Manual: spotbugs.readthedocs.io
โข SonarSource Community: community.sonarsource.com
์จ๋ผ์ธ ๊ฐ์:
โข Udemy, Coursera ๋ฑ์์ "Code Quality" ๊ฒ์
โข YouTube์ ๋ง์ ํํ ๋ฆฌ์ผ ์์
โข ์ฌ๋ฅ๋ท์์๋ ๊ด๋ จ ๊ฐ์๋ฅผ ์ฐพ์ ์ ์์ด!
์ฑ :
โข "Clean Code" by Robert C. Martin
โข "Refactoring" by Martin Fowler
โข "Effective Java" by Joshua Bloch
โข "Java Concurrency in Practice" by Brian Goetz
๋ธ๋ก๊ทธ์ ์ปค๋ฎค๋ํฐ:
โข Baeldung (baeldung.com) - ์๋ฐ ๊ด๋ จ ๊ณ ํ์ง ํํ ๋ฆฌ์ผ
โข DZone (dzone.com) - ๊ฐ๋ฐ์ ์ปค๋ฎค๋ํฐ
โข Stack Overflow - ์ง๋ฌธ๊ณผ ๋ต๋ณ
โข Reddit r/java - ์๋ฐ ๊ฐ๋ฐ์ ์ปค๋ฎค๋ํฐ
๊ฐ๋จํ Spring Boot ํ๋ก์ ํธ๋ฅผ ๋ง๋ค์ด๋ณผ๊ฒ. ์๋์ ์ผ๋ก ๋ช ๊ฐ์ง ๋ฌธ์ ๋ฅผ ํฌํจ์์ผ์ ์ ์ ๋ถ์ ๋๊ตฌ๊ฐ ์ด๋ป๊ฒ ์ฐพ์๋ด๋์ง ๋ณผ ๊ฑฐ์ผ.
// UserService.java - ๋ฌธ์ ๊ฐ ๋ง์ ์ฝ๋ ์์
public class UserService {
private List<User> users = new ArrayList<>();
// ๋ฌธ์ 1: Null ์ฒดํฌ ์์
public String getUserName(Long userId) {
User user = findUserById(userId);
return user.getName(); // NPE ๊ฐ๋ฅ!
}
// ๋ฌธ์ 2: ๋ฆฌ์์ค ๋์
public void exportUsers(String filename) throws IOException {
FileWriter writer = new FileWriter(filename);
for (User user : users) {
writer.write(user.toString() + "\n");
}
// writer.close() ํธ์ถ ์ ํจ!
}
// ๋ฌธ์ 3: SQL ์ธ์ ์
์ํ
public User findUserByName(String name, Connection conn) throws SQLException {
String sql = "SELECT * FROM users WHERE name = '" + name + "'";
Statement stmt = conn.createStatement();
ResultSet rs = stmt.executeQuery(sql);
// ...
}
// ๋ฌธ์ 4: ๋นํจ์จ์ ์ธ ๋ฌธ์์ด ์ฐ๊ฒฐ
public String generateReport() {
String report = "";
for (User user : users) {
report += user.getName() + ", ";
}
return report;
}
// ๋ฌธ์ 5: ๋๊ธฐํ ๋ฌธ์
private int counter = 0;
public synchronized void incrementCounter() {
counter++;
}
public int getCounter() { // ๋๊ธฐํ ์ ๋จ!
return counter;
}
// ๋ฌธ์ 6: ๋ณต์ก๋๊ฐ ๋๋ฌด ๋์
public boolean validateUser(User user) {
if (user != null) {
if (user.getName() != null) {
if (user.getName().length() > 0) {
if (user.getAge() > 0) {
if (user.getAge() < 150) {
if (user.getEmail() != null) {
if (user.getEmail().contains("@")) {
return true;
}
}
}
}
}
}
}
return false;
}
private User findUserById(Long userId) {
return users.stream()
.filter(u -> u.getId().equals(userId))
.findFirst()
.orElse(null);
}
}
2. ๋น๋ ์ค์ pom.xml์ ํ์ํ ํ๋ฌ๊ทธ์ธ๋ค์ ์ถ๊ฐ:
<build>
<plugins>
<!-- SpotBugs -->
<plugin>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<version>4.7.3.0</version>
<configuration>
<effort>Max</effort>
<threshold>Low</threshold>
<plugins>
<plugin>
<groupId>com.h3xstream.findsecbugs</groupId>
<artifactId>findsecbugs-plugin</artifactId>
<version>1.12.0</version>
</plugin>
</plugins>
</configuration>
</plugin>
<!-- JaCoCo for Coverage -->
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.10</version>
<executions>
<execution>
<goals>
<goal>prepare-agent</goal>
</goals>
</execution>
<execution>
<id>report</id>
<phase>test</phase>
<goals>
<goal>report</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
3. ๋ถ์ ์คํ# SpotBugs ์คํ
mvn clean compile spotbugs:check
# ํ
์คํธ ๋ฐ ์ปค๋ฒ๋ฆฌ์ง
mvn clean test
# SonarQube ๋ถ์
mvn sonar:sonar \
-Dsonar.projectKey=sample-project \
-Dsonar.host.url=http://localhost:9000 \
-Dsonar.login=your-token
4. ๊ฒฐ๊ณผ ํ์ธ ๋ฐ ์์ ๋ถ์ ๊ฒฐ๊ณผ๋ฅผ ๋ณด๋ฉด ์์์ ์๋์ ์ผ๋ก ๋ฃ์ ๋ฌธ์ ๋ค์ด ๋ชจ๋ ํ์ง๋ ๊ฑฐ์ผ. ์ด์ ํ๋์ฉ ์์ ํด๋ณด์!
// ๊ฐ์ ๋ UserService.java
public class UserService {
private final List<User> users = new CopyOnWriteArrayList<>();
private final AtomicInteger counter = new AtomicInteger(0);
// ๊ฐ์ 1: Null ์์ ์ฑ
public String getUserName(Long userId) {
return Optional.ofNullable(findUserById(userId))
.map(User::getName)
.orElse("Unknown");
}
// ๊ฐ์ 2: ๋ฆฌ์์ค ์๋ ๊ด๋ฆฌ
public void exportUsers(String filename) throws IOException {
try (FileWriter writer = new FileWriter(filename)) {
for (User user : users) {
writer.write(user.toString() + "\n");
}
} // ์๋์ผ๋ก close() ํธ์ถ
}
// ๊ฐ์ 3: PreparedStatement ์ฌ์ฉ
public User findUserByName(String name, Connection conn) throws SQLException {
String sql = "SELECT * FROM users WHERE name = ?";
try (PreparedStatement pstmt = conn.prepareStatement(sql)) {
pstmt.setString(1, name);
try (ResultSet rs = pstmt.executeQuery()) {
// ...
}
}
}
// ๊ฐ์ 4: StringBuilder ์ฌ์ฉ
public String generateReport() {
return users.stream()
.map(User::getName)
.collect(Collectors.joining(", "));
}
// ๊ฐ์ 5: AtomicInteger๋ก ๋๊ธฐํ ๋ฌธ์ ํด๊ฒฐ
public void incrementCounter() {
counter.incrementAndGet();
}
public int getCounter() {
return counter.get();
}
// ๊ฐ์ 6: Early Return์ผ๋ก ๋ณต์ก๋ ๊ฐ์
public boolean validateUser(User user) {
if (user == null) return false;
if (user.getName() == null || user.getName().isEmpty()) return false;
if (user.getAge() <= 0 || user.getAge() >= 150) return false;
if (user.getEmail() == null || !user.getEmail().contains("@")) return false;
return true;
}
private User findUserById(Long userId) {
return users.stream()
.filter(u -> u.getId().equals(userId))
.findFirst()
.orElse(null);
}
}
๋ค์ ๋ถ์์ ์คํํ๋ฉด ๋ชจ๋ ๋ฌธ์ ๊ฐ ํด๊ฒฐ๋ ๊ฑธ ํ์ธํ ์ ์์ด! ๐
โข ์ข์ ์ฝ๋๋ ๋จ์ํ "๋์๊ฐ๋ ์ฝ๋"๊ฐ ์๋๋ผ "์ ์ง๋ณด์ ๊ฐ๋ฅํ ์ฝ๋"
โข ์ด๊ธฐ ํฌ์๋ ํฌ์ง๋ง ์ฅ๊ธฐ์ ์ผ๋ก ์์ฒญ๋ ๋น์ฉ ์ ๊ฐ ํจ๊ณผ
โข ๊ฐ๋ฐ์์ ํ๋ณต๊ณผ ์์ฐ์ฑ์ ์ง์ ์ ์ธ ์ํฅ
์ ์ ๋ถ์์ ๊ฐ์น:
โข ๊ฐ๋ฐ ์ด๊ธฐ ๋จ๊ณ์์ ๋ฌธ์ ๋ฐ๊ฒฌ โ ์์ ๋น์ฉ ์ต์ํ
โข ์๋ํ๋ ์ฝ๋ ๋ฆฌ๋ทฐ โ ๋ฆฌ๋ทฐ์ด์ ๋ถ๋ด ๊ฐ์
โข ์ผ๊ด๋ ์ฝ๋ ํ์ง ์ ์ง โ ํ ์ ์ฒด์ ์ฝ๋ฉ ์ค๋ ฅ ํฅ์
SonarQube:
โข ์ข ํฉ์ ์ธ ์ฝ๋ ํ์ง ๊ด๋ฆฌ ํ๋ซํผ
โข ์น ๋์๋ณด๋๋ก ์๊ฐํ
โข CI/CD ํตํฉ ์ฉ์ด
โข ํ์ง ๊ฒ์ดํธ๋ก ํ์ง ๊ธฐ์ค ๊ฐ์
SpotBugs:
โข ๋ฐ์ดํธ์ฝ๋ ๋ถ์์ผ๋ก ๋ฒ๊ทธ ํ์ง
โข ๋น ๋ฅธ ๋ถ์ ์๋
โข IDE ํตํฉ์ผ๋ก ์ค์๊ฐ ํผ๋๋ฐฑ
โข ๋ณด์ ์ทจ์ฝ์ ํ์ง์ ๊ฐ์
1. IDE์ ํ๋ฌ๊ทธ์ธ ์ค์น (5๋ถ)
IntelliJ๋ Eclipse์ SpotBugs ํ๋ฌ๊ทธ์ธ์ ์ค์นํด๋ด. ๋น์ฅ ํจ๊ณผ๋ฅผ ๋ณผ ์ ์์ด!
2. ๋ก์ปฌ์์ SonarQube ์คํ (10๋ถ)
Docker๋ก SonarQube๋ฅผ ๋์ฐ๊ณ ํ๋ก์ ํธ๋ฅผ ๋ถ์ํด๋ด. ํ์ฌ ์ฝ๋์ ์ํ๋ฅผ ํ์ ํ๋ ๊ฒ ์ฒซ๊ฑธ์์ด์ผ.
3. ์์ ํ๋ก์ ํธ๋ถํฐ ์ ์ฉ (1์ฃผ)
์ฌ์ด๋ ํ๋ก์ ํธ๋ ์์ ๋ชจ๋๋ถํฐ ์์ํด์ ๊ฒฝํ์ ์์๋ด. ์ฑ๊ณต ๊ฒฝํ์ด ์ค์ํด!
4. ํ์ ์ ์ (2์ฃผ)
ํจ๊ณผ๋ฅผ ์ ์ฆํ ํ ํ์ ๋์ ์ ์ ์ํด๋ด. ๋ฐ์ดํฐ์ ์ฌ๋ก๋ฅผ ์ค๋นํ๋ฉด ์ค๋๋ ฅ์ด ๋์์ ธ.
5. ์ง์์ ์ธ ๊ฐ์ (๊ณ์)
๋๊ตฌ๋ฅผ ๋์ ํ๋ ๊ฒ์ผ๋ก ๋์ด ์๋์ผ. ๊ท์น์ ์กฐ์ ํ๊ณ , ๊ฑฐ์ง ์์ฑ์ ์ค์ด๊ณ , ํ์ ํผ๋๋ฐฑ์ ๋ฐ์ํ๋ฉด์ ๊ณ์ ๊ฐ์ ํด๋๊ฐ์ผ ํด.
์ฌ๋ฅ๋ท ๊ฐ์ ํ๋ซํผ์์ ์ฝ๋ ํ์ง ๊ด๋ฆฌ ๊ฒฝํ์ ๊ณต์ ํ๊ฑฐ๋, ๊ด๋ จ ๋ฉํ ๋ง์ ๋ฐ๋ ๊ฒ๋ ์ข์ ๋ฐฉ๋ฒ์ด์ผ. ํผ์ ๊ณ ๋ฏผํ์ง ๋ง๊ณ ์ปค๋ฎค๋ํฐ์ ํ์ ํ์ฉํด๋ด!
โข ํด๋ฆฐ ์ฝ๋ ์์น: SOLID, DRY, KISS, YAGNI ๋ฑ
โข ๋์์ธ ํจํด: ์ฌ์ฌ์ฉ ๊ฐ๋ฅํ ์๋ฃจ์ ํจํด
โข ๋ฆฌํฉํ ๋ง ๊ธฐ๋ฒ: ์ฝ๋๋ฅผ ๊ฐ์ ํ๋ ์ฒด๊ณ์ ์ธ ๋ฐฉ๋ฒ
โข ํ ์คํธ ์ฃผ๋ ๊ฐ๋ฐ(TDD): ํ ์คํธ๋ฅผ ๋จผ์ ์์ฑํ๋ ๊ฐ๋ฐ ๋ฐฉ๋ฒ๋ก
โข ์ง์์ ํตํฉ/๋ฐฐํฌ(CI/CD): ์๋ํ๋ ๋น๋์ ๋ฐฐํฌ
โข ์ฝ๋ ๋ฆฌ๋ทฐ ๋ฌธํ: ํจ๊ณผ์ ์ธ ์ฝ๋ ๋ฆฌ๋ทฐ ๋ฐฉ๋ฒ
โข ์ฑ๋ฅ ์ต์ ํ: ํ๋กํ์ผ๋ง๊ณผ ํ๋ ๊ธฐ๋ฒ
โข ๋ณด์ ์ฝ๋ฉ: ์์ ํ ์ฝ๋ ์์ฑ ๋ฐฉ๋ฒ
์ด ๋ชจ๋ ์ฃผ์ ๋ค์ด ์๋ก ์ฐ๊ฒฐ๋์ด ์์ด. ์ฝ๋ ํ์ง์ ๋จ์ํ ๋๊ตฌ์ ๋ฌธ์ ๊ฐ ์๋๋ผ, ๊ฐ๋ฐ ๋ฌธํ์ ํ๋ก์ธ์ค ์ ์ฒด์ ๋ฌธ์ ๊ฑฐ๋ . ๐
๐ ์ถํํด!
์ฌ๊ธฐ๊น์ง ์ฝ์๋ค๋ฉด ๋๋ ์ด๋ฏธ ์ฝ๋ ํ์ง์ ๋ํ ๊น์ ์ดํด๋ฅผ ๊ฐ๊ฒ ๋ ๊ฑฐ์ผ.
์ด์ ์ค์ ์์ ์ ์ฉํด๋ณด๊ณ , ๊ฒฝํ์ ์์๊ฐ๋ฉด์ ๋ ๋์ ๊ฐ๋ฐ์๋ก ์ฑ์ฅํด๋๊ฐ๊ธธ ๋ฐ๋ผ!
Happy Coding! ๐ปโจ
โข SpotBugs ๊ณต์ ์ฌ์ดํธ: spotbugs.github.io
โข SonarCloud: sonarcloud.io
โข OWASP Top 10: owasp.org/www-project-top-ten
โข Clean Code ์์น: cleancoders.com
โข ์ฌ๋ฅ๋ท ํ๋ก๊ทธ๋๋ฐ ์นดํ ๊ณ ๋ฆฌ: www.jaenung.net
์ฝ๋ ํ์ง ๊ด๋ฆฌ๋ ๋ง๋ผํค์ด์ง ๋จ๊ฑฐ๋ฆฌ ๋ฌ๋ฆฌ๊ธฐ๊ฐ ์๋์ผ. ๊พธ์คํ, ์ง์์ ์ผ๋ก ๊ฐ์ ํด๋๊ฐ๋ ๊ฒ ์ค์ํด. ์ค๋ ํ๋์ ๋ฒ๊ทธ๋ฅผ ๊ณ ์น๊ณ , ๋ด์ผ ํ๋์ ์ฝ๋ ์ค๋ฉ์ ์ ๊ฑฐํ๊ณ , ๋ชจ๋ ํ๋์ ํ ์คํธ๋ฅผ ์ถ๊ฐํ๋ค ๋ณด๋ฉด, ์ด๋์ ํ๋ก์ ํธ ์ ์ฒด์ ํ์ง์ด ํฌ๊ฒ ํฅ์๋์ด ์์ ๊ฑฐ์ผ. ๐ฑ
๊ทธ๋ฆฌ๊ณ ๊ธฐ์ตํด. ๋๊ตฌ๋ ๋๊ตฌ์ผ ๋ฟ์ด์ผ. ์ง์ง ์ค์ํ ๊ฑด ์ข์ ์ฝ๋๋ฅผ ์์ฑํ๋ ค๋ ๊ฐ๋ฐ์์ ๋ง์๊ฐ์ง์ด์ผ. ๋๊ตฌ๊ฐ ์๋ ค์ฃผ๋ ๋ฌธ์ ๋ฅผ ๋จ์ํ "๊ท์ฐฎ์ ๊ฒฝ๊ณ "๋ก ์น๋ถํ์ง ๋ง๊ณ , "๋ฐฐ์ธ ๊ธฐํ"๋ก ๋ฐ์๋ค์ฌ๋ด. ๊ทธ๋ ๊ฒ ํ๋์ฉ ๋ฐฐ์๊ฐ๋ค ๋ณด๋ฉด ์ด๋์ ๋๊ตฌ ์์ด๋ ์ข์ ์ฝ๋๋ฅผ ์์ฑํ ์ ์๊ฒ ๋ ๊ฑฐ์ผ. ๊ทธ๊ฒ ์ง์ง ์ค๋ ฅ์ด์ง! ๐ช
๋ง์ง๋ง์ผ๋ก, ์ฝ๋ ํ์ง์ ํผ์๋ง์ ๋ฌธ์ ๊ฐ ์๋์ผ. ํ ์ ์ฒด๊ฐ ํจ๊ป ๋ ธ๋ ฅํด์ผ ํ๋ ๋ถ๋ถ์ด์ง. ์๋ก์ ์ฝ๋๋ฅผ ๋ฆฌ๋ทฐํ๊ณ , ์ข์ ํจํด์ ๊ณต์ ํ๊ณ , ์ค์์์ ๋ฐฐ์ฐ๋ ๋ฌธํ๋ฅผ ๋ง๋ค์ด๊ฐ๋ ๊ฒ ์ค์ํด. ๊ทธ๋ฐ ์๋ฏธ์์ ์ ์ ๋ถ์ ๋๊ตฌ๋ ํ์ ๊ณตํต ์ธ์ด๊ฐ ๋์ด์ค ์ ์์ด. "์ด ์ฝ๋๋ SonarQube์์ Major ์ด์๋ก ๋์์"๋ผ๊ณ ํ๋ฉด, ์ฃผ๊ด์ ์ธ ์๊ฒฌ์ด ์๋๋ผ ๊ฐ๊ด์ ์ธ ๊ธฐ์ค์ผ๋ก ๋ํํ ์ ์๊ฑฐ๋ . ๐ค
์, ์ด์ ์ ๋ง๋ก ๋์ด์ผ! ๊ธด ๊ธ ์ฝ์ด์ค์ ๊ณ ๋ง์. ์ด ๊ธ์ด ๋์ ๊ฐ๋ฐ ์ฌ์ ์ ์กฐ๊ธ์ด๋ผ๋ ๋์์ด ๋์์ผ๋ฉด ์ข๊ฒ ์ด. ์ง๋ฌธ์ด๋ ํผ๋๋ฐฑ์ด ์๋ค๋ฉด ์ธ์ ๋ ์ปค๋ฎค๋ํฐ์ ๊ณต์ ํด์ค. ์ฐ๋ฆฌ ๋ชจ๋ ํจ๊ป ์ฑ์ฅํ๋ ๊ฑฐ๋๊น! ๐
ํ๋ณตํ ์ฝ๋ฉ ๋๊ธธ ๋ฐ๋ผ! See you in the code! ๐โจ
๊ด๋ จ ํค์๋
๋๊ธ ์์ฑ
์ด ๊ธ์ ๋ํ ์ฌ๋ฌ๋ถ์ ์๊ฐ์ ๋ค๋ ค์ฃผ์ธ์
๋ก๊ทธ์ธ์ด ํ์ํฉ๋๋ค
๋๊ธ์ ์์ฑํ๋ ค๋ฉด ๋จผ์ ๋ก๊ทธ์ธํด์ฃผ์ธ์.
๋๊ธ 0
์ง์์ธ์ ์ฒ - ์ง์ ์ฌ์ฐ๊ถ ๋ณดํธ ๊ณ ์ง
์ง์ ์ฌ์ฐ๊ถ ๋ณดํธ ๊ณ ์ง
- ์ ์๊ถ ๋ฐ ์์ ๊ถ: ๋ณธ ์ปจํ ์ธ ๋ ์ฌ๋ฅ๋ท์ ๋ ์ AI ๊ธฐ์ ๋ก ์์ฑ๋์์ผ๋ฉฐ, ๋ํ๋ฏผ๊ตญ ์ ์๊ถ๋ฒ ๋ฐ ๊ตญ์ ์ ์๊ถ ํ์ฝ์ ์ํด ๋ณดํธ๋ฉ๋๋ค.
- AI ์์ฑ ์ปจํ ์ธ ์ ๋ฒ์ ์ง์: ๋ณธ AI ์์ฑ ์ปจํ ์ธ ๋ ์ฌ๋ฅ๋ท์ ์ง์ ์ฐฝ์๋ฌผ๋ก ์ธ์ ๋๋ฉฐ, ๊ด๋ จ ๋ฒ๊ท์ ๋ฐ๋ผ ์ ์๊ถ ๋ณดํธ๋ฅผ ๋ฐ์ต๋๋ค.
- ์ฌ์ฉ ์ ํ: ์ฌ๋ฅ๋ท์ ๋ช ์์ ์๋ฉด ๋์ ์์ด ๋ณธ ์ปจํ ์ธ ๋ฅผ ๋ณต์ , ์์ , ๋ฐฐํฌ, ๋๋ ์์ ์ ์ผ๋ก ํ์ฉํ๋ ํ์๋ ์๊ฒฉํ ๊ธ์ง๋ฉ๋๋ค.
- ๋ฐ์ดํฐ ์์ง ๊ธ์ง: ๋ณธ ์ปจํ ์ธ ์ ๋ํ ๋ฌด๋จ ์คํฌ๋ํ, ํฌ๋กค๋ง, ๋ฐ ์๋ํ๋ ๋ฐ์ดํฐ ์์ง์ ๋ฒ์ ์ ์ฌ์ ๋์์ด ๋ฉ๋๋ค.
- AI ํ์ต ์ ํ: ์ฌ๋ฅ๋ท์ AI ์์ฑ ์ปจํ ์ธ ๋ฅผ ํ AI ๋ชจ๋ธ ํ์ต์ ๋ฌด๋จ ์ฌ์ฉํ๋ ํ์๋ ๊ธ์ง๋๋ฉฐ, ์ด๋ ์ง์ ์ฌ์ฐ๊ถ ์นจํด๋ก ๊ฐ์ฃผ๋ฉ๋๋ค.
์์ง ๋๊ธ์ด ์์ต๋๋ค.