[Intellij] SonarLint 쏘나린트

 

오늘은 SonarLint를 정리해볼까 합니다.

Intellij 툴 중 하나인 SonarLint로 코드 검토를 하니까 오류도 줄어들고 좋답니다.

더 잘 사용하기 위해 더 알아보기 위해 정리하고자 합니다 🦭

 

---

 

SonarLint는 소나큐브(SonarQube)와 통합하여 코드 품질을 분석하고 개선하는 도구입니다. 

주로 통합 개발 환경(IDE)에서 사용되며, 코드를 작성하는 동안 실시간으로 정적 코드 분석을 수행하여 잠재적인 버그, 취약성, 코드 스멜, 복잡성 등을 식별합니다. 

SonarLint는 다양한 IDE에서 사용 가능하며, IntelliJ IDEA, Eclipse, Visual Studio 등을 지원합니다.

 

💡 SonarQube와 SonarCloud는 뭐지?
병합 전에 pull request를 분석해서 코드 문제에 대한 추가적인 보호를 제공해준다. 각 build에서 코드를 분석해서, CI/CD 워크 플로우의 일부로 사용된다. 문제가 있는 코드가 배포되는 것을 방지해준다.

 

🧑‍🎄 SonarLint 이름 뜻?

SonarLint의 이름은 소나 (Sonar)와 린트 (Lint)의 결합으로 이루어져 있습니다.

1. Sonar (소나)

해양학에서 사용되는 음파를 이용하여 수중에서 물체의 위치를 감지하는 기술을 의미합니다. 이는 소나가 코드의 품질을 감지하고 분석하여 문제점을 찾아내는 것과 유사한 역할을 수행한다는 의미를 합니다.

 

2. Lint (린트)

소프트웨어 개발에서 코드의 오류나 잠재적인 문제를 찾아내기 위해 사용되는 도구를 가리키는 일반적인 용어입니다. 코드 린트는 코드의 스타일, 오류, 버그, 보안 문제 등을 식별하여 개발자에게 알려주는 좋은 녀석입니다.

따라서 이름으로만 봐도! SonarLint는 코드 품질을 향상시키기 위해 코드를 음파 탐지기처럼 스캔하고 분석하는 정적 코드 분석 도구를 나타냅니다. SonarLint를 통해 개발자가 코드 작성 중에 발생할 수 있는 문제를 감지하여 높은 품질의 소프트웨어를 개발할 수 있습니다.

 

---

🎄SonarLint의 특징

SonarLint는 크게 6가지 특징이 있습니다.

1. 정적 코드 분석
코드를 정적으로 분석하여 일반적인 코딩 표준을 준수하고 코드 품질을 향상시킬 수 있는 잠재적인 문제를 식별해줍니당.

2. 다양한 언어 지원
java, JavaScript, C#, Python 등 다양한 프로그래밍 언어를 지원함

3. 실시간 피드백
코드를 작성하는 동안 SonarLint는 IDE에서 실시간으로 피드백을 제공하여 코드 품질을 유지하고 향상시킬 수 있도록 도와줍니다.

 

4. 품질 프로파일
코드 품질을 측정하는 여러 프로파일을 제공하여 프로젝트에 적합한 프로파일을 선택할 수 있음

5. SonarQube 통합
SonarLint는 SonarQube 서버와 통합되어 프로젝트를 지속적으로 모니터링하고 더 넓은 범위의 품질 관리를 지원함

6. 자동 수정 제안
일부 문제에 대해 SonarLint는 자동으로 코드 수정을 제안하여 향후 발생할 수 있는 버그나 취약성을 방지함

 

---

☃️ SonarLint 사용 방법 (간단)

Intellij 플러그인 설정 메뉴로 가보면! SonarLint 플러그인을 설치할 수 있습니다.

그리고 코드를 작성하면, 실시간으로 SonarLint가 피드백을 해줍니다.

 

아래 그림은 sonarlint 테스트를 위한 간단한 JUnit 코드입니다. 

못 미더운 어피치 머리 위를 보시면, 빨간색 아이콘과 3이라는 숫자 보이시죵? 

이게 Sonarlint가 이슈로 등록한 개수 입니다.

 

 

누르면 아래에 CurrentFile 탭에서 이슈를 확인할 수 있는데요,

어떤 규칙에 의해서 이슈로 잡았고, 어떻게 고쳐야하는지도 친절하게 리뷰를 해주고 있습니다.

 

이 이슈들은 Plugin 설정에서 확인할 수 있는데, 만약 본인에게는 불필요한 규칙이라면 이슈로 잡히지 않게 설정할 수도 있습니다.

예를 들면, 회사에서 프로젝트에서 사용하는 패키지 이름에 대해 이슈가 잡혔는데 팀에서 정한 네이밍 규칙이라 이슈라고 볼 수는 없었습니다.

 

설정된 규칙들은 Settings-Tools-SonarLint-Rules에서 확인 가능합니다.

 

 

아래 사진처럼, 고치고 싶지 않은 이슈가 발견되면 그 때 그 때 disable 시킬 수도 있습니다.

 

 

---

☃️ SonarLint의 Clean Code 

Sonar 친구는 Clean Code 방법론을 적용해서 피드백을 제공한다. 공식 문서에서 제공하는 솔루션을 정리해보려 한다.

 

1. SonarLint의 컨셉 

아래 3가지 내용을 만족하는 Clean Code 상태를 달성하는데 목표를 두고 있습니다.

 

1) Clean Code Attributes: Clean Code 특성을 만족하는가

consistent, intentional, adaptable, responsible 주로 4가지로 카테고리를 나눕니다. 이를 만족하면 클린 코드가 됩니다.

 

2) Software quality: 소프트웨어 품질에 기여하는지

security, reliability, maintainability를 만족하는 소프트웨어인지.

 

3) Issue: 코드 내 이슈가 있는지

 

2. SonarLint 동작 방식

만약 이슈가 있다면, 그 코드는 위에서 정리한 SonarLint의 컨셉에 맞지 않는 코드인 것이다. 예를 들어, 의도가 없어 보인다거나 일관성이 없거나.

 

3. Clean Code Attributes

Clean code의 특성의 주요 카테고리를 조금 더 봐보자.

 

1) Consistent(일관성)

코드는 uniform, conventional적인 방법으로 작성된다. 모든 코드는 비슷하게 보이고, 정규적인 패턴을 따르고 여러 개발자가 코드에 기여해도 그 코드는 일관되어야 한다.

- formatted: 간격, 들여쓰기 등등 코드베이스에서 일관되게 유지해서, 파일과 여러 작성자간 통일성을 유지하자.

- conventinal: 코드를 예상 가능하게 진행하도록 하자. 인스턴스는 단일 선택을 고수하고, 적절한 프로그래밍 인터페이스와 언어 기능을 사용하자.

- Identifiable: 네이밍 규칙을 기반으로 일반적인 구조를 따르게 하자. 대/소문자, 접미사, 접두사 등등

 

2) Intentional (의도적)

코드는 명확하고 목적을 가진다. 의미가 있고 적절하게 구성되게 하자. 의도적인 코드는 명확하고 효율적인 코드인 것이다.

- Clear

- Logical

- Complete

- Efficient

 

3) Adaptable

코드는 확장 및 개발이 쉽도록 구조화 되어있게 만들자. 확장/재사용이 쉽도록 만드는 것이 좋다. 즉, 모듈화가 되어있어야하고 테스트가 되어있어야한다.

- Focused

- Distinct

- Modular

- Tested

 

4) Responsible

데이터에 대해 책임을 지자.

- Lawful

- Trustworthy

- Respectful

 

4. Software qualities

secure, reliable, maintainable 이 3가지 측면은 Sonar 솔루션에서 Software qualities라고 부릅니다. 코드에서 이슈가 감지되면 소프트웨어 품질에 영향이 있다고 판단하여 이슈의 심각도를 결정한다.

 

 

이를 IDE에서 이슈로 등록되어 우리가 확인할 수 있는 것이다.

 

 

 

---

☃️ Clean as You Code

'Clean as You Code'은 전통적인 방법론에서 발생하는 많은 도전과제를 제거하는 코드 품질에 대한 접근 방식입니다. 개발자로서, 당신은 높은 기준을 유지하고 특히 작업 중인 새로운 코드에 대해 책임을 져야한다.

 

Focus on new code

코드를 작성할 때 항상 new code를 신경쓰도록 하자. 클린~하고 안전하게 새로운 코드를 작성하자.

 

Sonar에서 Clean as You Code 접근 방식에 대한 파일을 제공하더라구요. -> 링크 

인상 깊게 본 내용만 간단히 정리해봤습니다.

 

What is Clean as You Code?

코드베이스가 문제 없는 상태로 되어, 개발 및 제품화에 적합한 상태를 의미한다. 코드 품질을 점차적으로 향상시키는데 기여한다.

 

Why is Clean as You Code important?

개발자들이 clean code를 관행으로 사용하면, 팀이 예전 문제를 해결하거나 새롭게 만든 문제를 다시 작업하는 데 적은 시간을 사용하면 새로운 기능을 만들 때 불필요한 재작업 비용을 피할 수 있다. 

새로운 코드를 만들면서, 기존 코드도 개선해나간다면 전체 프로젝트는 결과적으로 언제나 깨끗하게 유지될 수 있다.

 

What you acieve with Clean as You Code (장점)

• The state of clean code
• developer ownership of the codebase
• organization-wide standard for clean code
• reduced effor on rework

What makes Clean as You Code different? (특징)

• 새로운 문제를 추가하지 않으면서 시간이 지남에 따라 이전 문제를 수정함으로써 코드베이스 전반의 품질을 높임
• 코드를 이해하기 쉽고 언제든지 어떤 개발자든 수리하고 향상시킬 수 있도록 유지 가능하게 만듦
• 비즈니스에 비용이 많이 들지 않도록 계속해서 가동 가능하게 유지하고 장기적인 신뢰성을 보장함

SonarQube나 SonarCloud를 연동하여 같이 사용하면 코드 품질을 확인하는 UI도 있는가봅니다.

SonarLint를 사용해서 Quality gate를 통과해보도록 노력해야겠습니다.

 

 

---

Rules

SonarLint에서 언어별로 다루는 규칙들은 아래 사이트에서도 볼 수 있습니다.

 

https://rules.sonarsource.com/java/

Java static code analysis

 

 

---

참고 자료

https://docs.sonarsource.com/sonarlint/intellij/concepts/clean-code/

Clean Code - SonarLint for IntelliJ