diff --git a/README.md b/README.md index 8d7e8aee..ff68a849 100644 --- a/README.md +++ b/README.md @@ -1 +1,9 @@ -# java-baseball-precourse \ No newline at end of file +# java-baseball-precourse + +## 기능 목록 +- 게임 시작 시 1~9 사이 중복 없는 3자리 컴퓨터 숫자를 생성한다. +- 사용자가 3자리 숫자를 입력하면 결과(스트라이크/볼/낫싱)를 계산한다. +- 결과에 따라 메시지를 출력한다. +- 3스트라이크가 되면 종료 메시지를 출력한다. +- 종료 후 재시작(1) 또는 종료(2)를 선택할 수 있다. +- 잘못된 입력은 `[ERROR]`로 시작하는 메시지를 출력하고 다시 입력받는다. diff --git a/ideas/javaconvention.html b/ideas/javaconvention.html new file mode 100644 index 00000000..ec353c63 --- /dev/null +++ b/ideas/javaconvention.html @@ -0,0 +1,2577 @@ +
+
+
+
+

v1.2.0, 2020.07.24

+
+
+
+
+

1. 파일 공통 요건

+
+
+

1.1. 파일 인코딩은 UTF-8

+
+

[encoding-utf8]

+
+
+

모든 소스, 텍스트 문서 파일의 인코딩은 UTF-8로 통일한다.

+
+
+
+

1.2. 새줄 문자는 LF

+
+

[newline-lf]

+
+
+

Unix 형식의 새줄 문자(newline)인 LF(Line Feed, 0x0A)을 사용한다. Windows 형식인 CRLF가 섞이지 않도록 편집기와 GIT 설정 등을 확인한다.

+
+
+

Git을 쓴다면 .gitattributes 파일 안에 정책을 선언해서 지정된 새줄 문자로 강제 변환하거나 예외가 될 확장자를 지정할 수 있다. 아래는 그 예시이다.

+
+
+
+
*.c text eol=lf
+*.cpp text eol=lf
+*.h text eol=lf
+
+# exception for visual studio project configuration
+*.sln text eol=crlf
+*.vs text eol=crlf
+*.csproj eol=crlf
+*.props eol=crlf
+*.filters eol=crlf
+
+
+
+

.gitattributes 파일은 디렉토리별로 지정할 수 있다. 전체 프로젝트에 적용한다면 최상위 디렉토리에 둔다.

+
+
+
+

1.3. 파일의 마지막에는 새줄

+
+

[newline-eof]

+
+
+

파일의 마지막은 새줄 문자 LF로 끝나야 한다.

+
+
+
+
+
+

2. 이름 (Naming)

+
+
+

2.1. 식별자에는 영문/숫자/언더스코어만 허용

+
+

[identifier-char-scope]

+
+
+

변수명, 클래스명, 메서드명 등에는 영어와 숫자만을 사용한다. 상수에는 단어 사이의 구분을 위하여 언더스코어(_)를 사용한다. 정규표현식 `[^A-Za-z0-9_]`에 부합해야 한다.

+
+
+
+

2.2. 한국어 발음대로의 표기 금지

+
+

[avoid-korean-pronounce]

+
+
+

식별자의 이름을 한글 발음을 영어로 옮겨서 표기하지 않는다. 한국어 고유명사는 예외이다.

+
+
+
    +
  • +

    나쁜 예 : moohyungJasan (무형자산)

    +
    • +
  • +

    좋은 예 : intangibleAssets (무형자산)

    +
    • +
+
+
+
+

2.3. 대문자로 표기할 약어 명시

+
+

[list-uppercase-abbr]

+
+
+

클래스명, 변수명에 쓰일 단어 중 모든 글자를 대문자로 표기할 약어의 목록을 프로젝트별로 명시적으로 정의한다.

+
+
+

약어의 대소문자 표기는 JDK의 클래스나 라이브러리들 사이에서도 일관된 규칙이 없다. +`javax.xml.bind.annotation.XmlElement`처럼 약어를 소문자로 표기하기도 하고, `java.net.HttpURLConnection`처럼 한 클래스 안에서 단어별로 다르게 쓰기도 했다. +그러나 단일 프로젝트에서는 규칙이 명확하지 않으면 같은 단어의 조합을 다른 이름으로 표기할 수 있어서 혼동을 유발한다.

+
+
+

약어가 클래스명에서 대문자로 들어가면 단어 간의 구분을 인지하기에 불리하다. 약어가 연속된 경우 더욱 가독성을 해친다. 예를 들면 XMLRPCHTTPAPIURL과 같은 경우이다. +그래서 기본 정책으로는 약어의 중간단어를 소문자로 표기하고 프로젝트별로 모두 대문자로 표기할 약어의 목록을 명시하는 방식이 가독성을 높이고 규칙을 단순화하는데 유리하다. +즉 프로젝트 내에서 정의한 단어 목록이 없다면 'XmlRpcHttpApiUrl’과 같이 쓴다.

+
+
+
좋은 예
+

HTTP + API + URL 의 클래스 이름의 경우

+
+
+
    +
  • +

    대문자로 표기할 약어의 목록을 정의하지 않는 경우 : HttpApiUrl

    +
    • +
  • +

    API만 대문자로 표기할 약어의 목록에 있을 경우 : HttpAPIUrl

    +
    • +
  • +

    HTTP, API, URL이 대문자로 표기할 약어의 목록에 있을 경우 : HTTPAPIURL

    +
    • +
+
+
+
+

2.4. 패키지 이름은 소문자로 구성

+
+

[package-lowercase]

+
+
+

패키지 이름은 소문자를 사용하여 작성한다. 단어별 구문을 위해 언더스코어(_)나 대문자를 섞지 않는다.

+
+
+
나쁜 예
+
+
package com.navercorp.apiGateway
+
+package com.navercorp.api_gateway
+
+
+
+
좋은 예
+
+
package com.navercorp.apigateway
+
+
+
+
+

2.5. 클래스/인터페이스 이름에 대문자 카멜표기법 적용

+
+

[class-interface-lower-camelcase]

+
+
+

클래스 이름은 단어의 첫 글자를 대문자로 시작하는 대문자 카멜표기법(Upper camel case)을 사용한다. 파스칼표기법(Pascal case)으로도 불린다.

+
+
+
나쁜 예
+
+
public class reservation
+
+public class Accesstoken
+
+
+
+
좋은 예
+
+
public class Reservation
+
+public class AccessToken
+
+
+
+
+

2.6. 클래스 이름에 명사 사용

+
+

[class-noun]

+
+
+

클래스 이름은 명사나 명사절로 짓는다.

+
+
+
+

2.7. 인터페이스 이름에 명사/형용사 사용

+
+

[interface-noun-adj]

+
+
+

인터페이스(interface)의 이름은 클래스 이름은 명사/명사절로 혹은 형용사/형용사절로 짓는다.

+
+
+
좋은 예
+
+
public interface RowMapper {
+
+public interface AutoClosable {
+
+
+
+
+

2.8. 테스트 클래스는 'Test’로 끝남

+
+

[test-class-suffix]

+
+
+

JUnit 등으로 작성한 테스트 코드를 담은 클래스는 'Test’을 마지막에 붙인다.

+
+
+
좋은 예
+
+
public class WatcherTest {
+
+
+
+
+

2.9. 메서드 이름에 소문자 카멜표기법 적용

+
+

[method-lower-camelcase]

+
+
+

메서드의 이름에는 첫 번째 단어를 소문자로 작성하고, 이어지는 단어의 첫 글자를 대문자로 작성하는 소문자 카멜표기법(Lower camel case)를 사용한다. 테스트 클래스의 메서드 이름에서는 언더스코어를 허용한다.

+
+
+
+

2.10. 메서드 이름은 동사/전치사로 시작

+
+

[method-verb-preposition]

+
+
+

메서드명은 기본적으로는 동사로 시작한다. 다른 타입으로 전환하는 메서드나 빌더 패턴을 구현한 클래스의 메서드에는 전치사를 쓸 수 있다.

+
+
+
좋은 예
+
    +
  • +

    동사사용 : renderHtml()

    +
    • +
  • +

    전환메서드의 전치사 : toString()

    +
    • +
  • +

    Builder 패턴 적용한 클래스의 메서드의 전치사 : withUserId(String id)

    +
    • +
+
+
+
+

2.11. 상수는 대문자와 언더스코어로 구성

+
+

[constant_uppercase]

+
+
+

상태를 가지지 않는 자료형이면서 static final`로 선언되어 있는 필드일 때를 상수로 간주한다. 상수 이름은 대문자로 작성하며, 복합어는 언더스코어(`_)를 사용하여 단어를 구분한다.

+
+
+
좋은 예
+
+
public final int UNLIMITED = -1;
+public final String POSTAL_CODE_EXPRESSION = “POST”;
+
+
+
+
+

2.12. 변수에 소문자 카멜표기법 적용

+
+

[var-lower-camelcase]

+
+
+

상수가 아닌 클래스의 멤버변수/지역변수/메서드 파라미터에는 소문자 카멜표기법(Lower camel case)을 사용한다.

+
+
+
나쁜 예
+
+
private boolean Authorized;
+private int AccessToken;
+
+
+
+
좋은 예
+
+
private boolean authorized;
+private int accessToken;
+
+
+
+
+

2.13. 임시 변수 외에는 1 글자 이름 사용 금지

+
+

[avoid-1-char-var]

+
+
+

메서드 블럭 범위 이상의 생명 주기를 가지는 변수에는 1글자로 된 이름을 쓰지 않는다. 반복문의 인덱스나 람다 표현식의 파라미터 등 짧은 범위의 임시 변수에는 관례적으로 1글자 변수명을 사용할 수 있다.

+
+
+
나쁜 예
+
+
HtmlParser p = new HtmlParser();
+
+
+
+
좋은 예
+
+
HtmlParser parser = new HtmlParser();
+
+
+
+
+
+
+

3. 선언 (Declarations)

+
+
+

클래스, 필드, 메서드, 변수값, import문 등의 소스 구성요소를 선언할 때 고려해야할 규칙이다.

+
+
+

3.1. 소스파일당 1개의 탑레벨 클래스를 담기

+
+

[1-top-level-class]

+
+
+

탑레벨 클래스(Top level class)는 소스 파일에 1개만 존재해야 한다. +( 탑레벨 클래스 선언의 컴파일타임 에러 체크에 대해서는 Java Language Specification 7.6 참조 )

+
+
+
나쁜 예
+
+
public class LogParser {
+}
+
+class LogType {
+}
+
+
+
+
좋은 예
+
+
public class LogParser {
+    // 굳이 한 파일안에 선언해야 한다면 내부 클래스로 선언
+    class LogType {
+    }
+}
+
+
+
+
+

3.2. static import에만 와일드 카드 허용

+
+

[avoid-star-import]

+
+
+

클래스를 import할때는 와일드카드(*) 없이 모든 클래스명을 다 쓴다. static import에서는 와일드카드를 허용한다.

+
+
+
나쁜 예
+
+
import java.util.*;
+
+
+
+
좋은 예
+
+
import java.util.List;
+import java.util.ArrayList;
+
+
+
+
+

3.3. 제한자 선언의 순서

+
+

[modifier-order]

+
+
+

클래스/메서드/멤버변수의 제한자는 Java Language Specification에서 명시한 아래의 순서로 쓴다.

+
+
+

public protected private abstract static final transient volatile synchronized native strictfp

+
+
+

( Java Language Specification - Chapter 18. Syntax 참조)

+
+
+
+

3.4. 애너테이션 선언 후 새줄 사용

+
+

[newline-after-annotation]

+
+
+

클래스, 인터페이스, 메서드, 생성자에 붙는 애너테이션은 선언 후 새줄을 사용한다. 이 위치에서도 파라미터가 없는 애너테이션 1개는 같은 줄에 선언할 수 있다.

+
+
+
좋은 예
+
+
@RequestMapping("/guests")
+public void findGuests() {}
+
+
+
+
좋은 예
+
+
@Override public void destroy() {}
+
+
+
+
+

3.5. 한 줄에 한 문장

+
+

[1-state-per-line]

+
+
+

문장이 끝나는 ; 뒤에는 새줄을 삽입한다. 한 줄에 여러 문장을 쓰지 않는다.

+
+
+
나쁜 예
+
+
int base = 0; int weight = 2;
+
+
+
+
좋은 예
+
+
int base = 0;
+int weight = 2;
+
+
+
+
+

3.6. 하나의 선언문에는 하나의 변수만

+
+

[1-var-per-declaration]

+
+
+

변수 선언문은 한 문장에서 하나의 변수만을 다룬다.

+
+
+
나쁜 예
+
+
int base, weight;
+
+
+
+
좋은 예
+
+
int base;
+int weight;
+
+
+
+
+

3.7. 배열에서 대괄호는 타입 뒤에 선언

+
+

[array-square-after-type]

+
+
+

배열 선언에 오는 대괄호([])는 타입의 바로 뒤에 붙인다. 변수명 뒤에 붙이지 않는다.

+
+
+
나쁜 예
+
+
String names[];
+
+
+
+
좋은 예
+
+
String[] names;
+
+
+
+
+

3.8. `long`형 값의 마지막에 `L`붙이기

+
+

[long-value-suffix]

+
+
+

long형의 숫자에는 마지막에 대문자 'L’을 붙인다. 소문자 'l’보다 숫자 '1’과의 차이가 커서 가독성이 높아진다.

+
+
+
나쁜 예
+
+
long base = 54423234211l;
+
+
+
+
좋은 예
+
+
long base = 54423234211L;
+
+
+
+
+

3.9. 특수 문자의 전용 선언 방식을 활용

+
+

[special-escape]

+
+
+

\b, \f, \n,\r,\t, `\", \\ 와 같이 특별히 정의된 선언 방식이 있는 특수 문자가 있다. 이런 문자들은 숫자를 이용한 \008 이나 `\u0008`와 같은 숫자를 넣은 선언보다 전용 방식을 활용한다.

+
+
+
나쁜 예
+
+
System.out.println("---\012---");
+
+
+
+
좋은 예
+
+
System.out.println("---\n---");
+
+
+
+
+
+
+

4. 들여쓰기 (Indentation)

+
+
+

들여쓰기는 코드의 계층을 구분하기 위해 추가하는 문자이다.

+
+
+

4.1. 하드탭 사용

+
+

[indentation-tab]

+
+
+

탭(tab) 문자를 사용하여 들여쓴다. 탭 대신 스페이스를 사용하지 않는다. 이를 잘 준수하기 위해서 스페이스와 탭을 구별해서 보여주도록 에디터를 설정한다.

+
+
+
+

4.2. 탭의 크기는 4개의 스페이스

+
+

[4-spaces-tab]

+
+
+

1개의 탭의 크기는 스페이스 4개와 같도록 에디터에서 설정한다.

+
+
+
+

4.3. 블럭 들여쓰기

+
+

[block-indentation]

+
+
+

클래스, 메서드, 제어문 등의 코드 블럭이 생길 때마다 1단계를 더 들여쓴다.

+
+
+
+
+
+

5. 중괄호 (Braces)

+
+
+

중괄호({,}) 는 클래스, 메서드, 제어문의 블럭을 구분한다.

+
+
+

5.1. K&R 스타일로 중괄호 선언

+
+

[braces-knr-style]

+
+
+

클래스 선언, 메서드 선언, 조건/반복문 등의 코드 블럭을 감싸는 중괄호에 적용되는 규칙이다. 중괄호 선언은 K&R 스타일(Kernighan and Ritchie style)을 따른다. 줄의 마지막에서 시작 중괄호`{`를 쓰고 열고 새줄을 삽입한다. 블럭을 마친후에는 새줄 삽입 후 중괄호를 닫는다.

+
+
+
나쁜 예
+
+
public class SearchConditionParser
+{
+    public boolean isValidExpression(String exp)
+    {
+
+        if (exp == null)
+        {
+            return false;
+        }
+
+        for (char ch : exp.toCharArray())
+        {
+             ....
+        }
+
+        return true;
+    }
+}
+
+
+
+
좋은 예
+
+
public class SearchConditionParser {
+    public boolean isValidExpression(String exp) {
+
+        if (exp == null) {
+            return false;
+        }
+
+        for (char ch : exp.toCharArray()) {
+            ....
+        }
+
+        return true;
+    }
+}
+
+
+
+
+

5.2. 닫는 중괄호와 같은 줄에 else, catch, finally, while 선언

+
+

[sub-flow-after-brace]

+
+
+

아래의 키워드는 닫는 중괄호(}) 와 같은 줄에 쓴다.

+
+
+
    +
  • +

    else

    +
    • +
  • +

    catch, finaly

    +
    • +
  • +

    do-while 문에서의 while

    +
    • +
+
+
+
나쁜 예
+
+
if (line.startWith(WARNING_PREFIX)) {
+    return LogPattern.WARN;
+}
+else if (line.startWith(DANGER_PREFIX)) {
+    return LogPattern.DANGER;
+}
+else {
+    return LogPattern.NORMAL;
+}
+
+
+
+
좋은 예
+
+
if (line.startWith(WARNING_PREFIX)) {
+    return LogPattern.WARN;
+} else if (line.startWith(DANGER_PREFIX)) {
+    return LogPattern.NORMAL;
+} else {
+    return LogPattern.NORMAL;
+}
+
+
+
+
나쁜 예
+
+
try {
+    writeLog();
+}
+catch (IOException ioe) {
+    reportFailure(ioe);
+}
+finally {
+    writeFooter();
+}
+
+
+
+
좋은 예
+
+
try {
+    writeLog();
+} catch (IOException ioe) {
+    reportFailure(ioe);
+} finally {
+    writeFooter();
+}
+
+
+
+
나쁜 예
+
+
do {
+    write(line);
+    line = readLine();
+}
+while (line != null);
+
+
+
+
좋은 예
+
+
do {
+    write(line);
+    line = readLine();
+} while (line != null);
+
+
+
+
+

5.3. 빈 블럭에 새줄 없이 중괄호 닫기 허용

+
+

[permit-concise-empty-block]

+
+
+

내용이 없는 블럭을 선언할 때는 같은 줄에서 중괄호를 닫는 것을 허용한다.

+
+
+
좋은 예
+
+
public void close() {}
+
+
+
+
+

5.4. 조건/반복문에 중괄호 필수 사용

+
+

[need-braces]

+
+
+

조건, 반복문이 한 줄로 끝더라도 중괄호를 활용한다. 이 문서에 언급된 중괄호의 전후의 공백, 제어문 앞 뒤의 새줄 규칙도 함께 고려한다.

+
+
+
나쁜 예
+
+
if (exp == null) return false;
+
+for (char ch : exp.toCharArray()) if (ch == 0) return false;
+
+
+
+
좋은 예
+
+
if (exp == null) {
+    return false;
+}
+
+for (char ch : exp.toCharArray()) {
+
+    if (ch == 0) {
+        return false;
+    }
+
+}
+
+
+
+
+
+
+

6. 줄바꿈 (Line-wrapping)

+
+
+

줄바꿈은 작성한 명령어가 줄 너비를 초과했을 경우 코드 가독성을 위해서 강제로 줄을 바꾸는 것을 말한다.

+
+
+

6.1. 최대 줄 너비는 120

+
+

[line-length-120]

+
+
+

최대 줄 사용 너비는 120자까지 가능하다.

+
+
+
+

6.2. package,import 선언문은 한 줄로

+
+

[1-line-package-import]

+
+
+

package,import 선언문 중간에서는 줄을 바꾸지 않는다. 최대 줄수를 초과하더라도 한 줄로 쓴다.

+
+
+
+

6.3. 줄바꿈 후 추가 들여쓰기

+
+

[indentation-after-line-wrapping]

+
+
+

줄바꿈 이후 이어지는 줄에서는 최초 시작한 줄에서보다 적어도 1단계의 들여쓰기를 더 추가한다. +IDE의 자동 포메팅 기능으로 이를 동일하게 맞추러면 Appendix C의 각 IDE별 설정을 참고한다.

+
+
+
좋은 예
+
+
AbstractAggregateRootTest.AggregateRoot proxyAggregateRoot =
+        em.getReference(AbstractAggregateRootTest.AggregateRoot.class, aggregateRoot.getId());
+
+
+
+
+

6.4. 줄바꿈 허용 위치

+
+

[line-wrapping-position]

+
+
+

가독성을 위해 줄을 바꾸는 위치는 다음 중의 하나로 한다.

+
+
+
    +
  • +

    extends 선언 후

    +
    • +
  • +

    implements 선언 후

    +
    • +
  • +

    throws 선언 후

    +
    • +
  • +

    시작 소괄호(() 선언 후

    +
    • +
  • +

    콤마(,) 후

    +
    • +
  • +

    . 전

    +
    • +
  • +

    연산자 전

    +
    +
      +
    • +

      +, -, *, /, %

      +
      • +
    • +

      ==, !=, >=, >,⇐, <, &&, ||

      +
      • +
    • +

      &, |, ^, >>>, >>, <<, ?

      +
      • +
    • +

      instanceof

      +
      • +
    +
    +
    • +
+
+
+
좋은 예
+
+
public boolen isAbnormalAccess (
+    User user, AccessLog log) {
+
+    String message = user.getId() + "|" | log.getPrefix()
+        + "|" + SUFFIX;
+}
+
+
+
+
+
+
+

7. 빈 줄(Blank lines)

+
+
+

빈 줄은 명령문 그룹의 영역을 표시하기 위하여 사용한다.

+
+
+

7.1. package 선언 후 빈 줄 삽입

+
+

[blankline-after-package]

+
+
+
좋은 예
+
+
package com.naver.lucy.util;
+
+import java.util.Date;
+
+
+
+
+

7.2. import 선언의 순서와 빈 줄 삽입

+
+

[import-grouping]

+
+
+

import 구절은 아래와 같은 순서로 그룹을 묶어서 선언한다.

+
+
+
    +
  1. +

    static imports

    +
    2. +
  2. +

    java.

    +
    3. +
  3. +

    javax.

    +
    4. +
  4. +

    org.

    +
    5. +
  5. +

    net.

    +
    6. +
  6. +

    8~10을 제외한 com.*

    +
    7. +
  7. +

    1~6, 8~10을 제외한 패키지에 있는 클래스

    +
    8. +
  8. +

    com.nhncorp.

    +
    9. +
  9. +

    com.navercorp.

    +
    10. +
  10. +

    com.naver.

    +
    11. +
+
+
+

각 그룹 사이에는 빈줄을 삽입한다. +같은 그룹 내에서는 알파벳 순으로 정렬한다.

+
+
+
좋은 예
+
+
import java.util.Date;
+import java.util.List;
+
+import javax.naming.NamingException;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.springframework.util.Assert;
+
+import com.google.common.base.Function;
+
+import com.naver.lucy.util.AnnotationUtils;
+
+
+
+

이 규칙은 대부분 IDE에서 자동으로 정리해주는 대로 쓰기 때문에 IDE 설정을 일치시키는데 신경을 써야 한다.

+
+
+
+

7.3. 메소드 사이에 빈 줄 삽입

+
+

[blankline-between-methods]

+
+
+

메서드의 선언이 끝난 후 다음 메서드 선언이 시작되기 전에 빈줄을 삽입한다.

+
+
+
좋은 예
+
+
public void setId(int id) {
+    this.id = id;
+}
+
+public void setName(String name) {
+this.name = name;
+}
+
+
+
+
+
+
+

8. 공백 (Whitespace)

+
+
+

8.1. 공백으로 줄을 끝내지 않음

+
+

[no-trailing-spaces]

+
+
+

빈줄을 포함하여 모든 줄은 탭이나 공백으로 끝내지 않는다.

+
+
+
+

8.2. 대괄호 뒤에 공백 삽입

+
+

[space-after-bracket]

+
+
+

닫는 대괄호(]) 뒤에 `;`으로 문장이 끝나지 않고 다른 선언이 올 경우 공백을 삽입한다.

+
+
+
나쁜 예
+
+
int[]masks = new int[]{0, 1, 1};
+
+
+
+
좋은 예
+
+
int[] masks = new int[] {0, 1, 1};
+
+
+
+
+

8.3. 중괄호의 시작 전, 종료 후에 공백 삽입

+
+

[space-around-brace]

+
+
+

여는 중괄호({) 앞에는 공백을 삽입한다. 닫는 중괄호(}) 뒤에 else ,catch 등의 키워드가 있을 경우 중괄호와 키워드 사이에 공백을 삽입한다.

+
+
+
좋은 예
+
+
public void printWarnMessage(String line) {
+    if (line.startsWith(WARN_PREFIX)) {
+        ...
+    } else {
+        ...
+    }
+}
+
+
+
+
+

8.4. 제어문 키워드와 여는 소괄호 사이에 공백 삽입

+
+

[space-between-keyword-parentheses]

+
+
+

if, for, while, catch, synchronized, switch`와 같은 제어문 키워드의 뒤에 소괄호((,)`)를 선언하는 경우, 시작 소괄호 앞에 공백을 삽입한다.

+
+
+
좋은 예
+
+
if (maxLine > LIMITED) {
+    return false;
+}
+
+
+
+
+

8.5. 식별자와 여는 소괄호 사이에 공백 미삽입

+
+

[no-space-between-identifier-parentheses]

+
+
+

식별자와 여는 소괄호(() 사이에는 공백을 삽입하지 않는다. 생성자와 메서드의 선언, 호출, 애너테이션 선언 뒤에 쓰이는 소괄호가 그에 해당한다.

+
+
+
나쁜 예
+
+
public StringProcessor () {} // 생성자
+
+@Cached ("local")
+public String removeEndingDot (String original) {
+assertNotNull (original);
+...
+}
+
+
+
+
좋은 예
+
+
public StringProcessor() {} // 생성자
+
+@Cached("local")
+public String removeEndingDot(String original) {
+assertNotNull(original);
+...
+}
+
+
+
+
+

8.6. 타입 캐스팅에 쓰이는 소괄호 내부 공백 미삽입

+
+

[no-space-typecasting]

+
+
+

타입캐스팅을 위해 선언한 소괄호의 내부에는 공백을 삽입하지 않는다.

+
+
+
나쁜 예
+
+
String message = ( String ) rawLine;
+
+
+
+
좋은 예
+
+
String message = (String)rawLine;
+
+
+
+
+

8.7. 제네릭스 산괄호의 공백 규칙

+
+

[generic-whitespace]

+
+
+

제네릭스(Generics) 선언에 쓰이는 산괄호(<,>) 주위의 공백은 다음과 같이 처리한다.

+
+
+
    +
  • +

    제네릭스 메서드 선언 일 때만 < 앞에 공백을 삽입한다.

    +
    • +
  • +

    < 뒤에 공백을 삽입하지 않는다.

    +
    • +
  • +

    > 앞에 공백을 삽입하지 않는다.

    +
    • +
  • +

    아래의 경우를 제외하고는 `>`뒤에 공백을 삽입한다.

    +
    +
      +
    • +

      메서드 레퍼런스가 바로 이어질 때

      +
      • +
    • +

      여는 소괄호('(')가 바로 이어질 때

      +
      • +
    • +

      메서드 이름이 바로 이어질 때

      +
      • +
    +
    +
    • +
+
+
+
좋은 예
+
+
public static <A extends Annotation> A find(AnnotatedElement elem, Class<A> type) { // 제네릭스 메서드 선언
+    List<Integer> l1 = new ArrayList<>(); // '(' 가 바로 이어질때
+    List<String> l2 = ImmutableList.Builder<String>::new; // 메서드 레퍼런스가 바로 이어질 때
+    int diff = Util.<Integer, String>compare(l1, l2); // 메서드 이름이 바로 이어질 때
+}
+
+
+
+
+

8.8. 콤마/구분자 세미콜론의 뒤에만 공백 삽입

+
+

[space-after-comma-semicolon]

+
+
+

콤마(,)와 반복문(while, for)의 구분자로 쓰이는 세미콜론(;)에는 뒤에만 공백을 삽입한다.

+
+
+
나쁜 예
+
+
for (int i = 0;i < length;i++) {
+    display(level,message,i)
+}
+
+
+
+
좋은 예
+
+
for (int i = 0; i < length; i++) {
+    display(level, message, i)
+}
+
+
+
+
+

8.9. 콜론의 앞 뒤에 공백 삽입

+
+

[space-around-colon]

+
+
+

반복문과 삼항연산자에서 콜론(:)의 앞 뒤에는 공백을 삽입한다. 라벨 선언 뒤에는 아무런 문자열이 없으므로 앞에만 공백을 삽입한다.

+
+
+
좋은 예
+
+
for (Customer customer : visitedCustomers) {
+    AccessPattern pattern = isAbnormal(accessLog) ? AccessPattern.ABUSE : AccessPattern.NORMAL;
+    int grade = evaluate(customer, pattern);
+
+    switch (grade) {
+        case GOLD :
+            sendSms(customer);
+        case SILVER :
+            sendEmail(customer);
+        default :
+            inreasePoint(customer)
+    }
+}
+
+
+
+
+

8.10. 이항/삼항 연산자의 앞 뒤에 공백 삽입

+
+

[space-around-binary-ternary-operator]

+
+
+

이항/삼항 연산자의 앞 뒤에는 공백을 삽입한다.

+
+
+
좋은 예
+
+
if (pattern == Access.ABNORMAL) {
+    return 0;
+}
+
+finalScore += weight * rawScore - absentCount;
+
+if (finalScore > MAX_LIMIT) {
+return MAX_LIMIT;
+}
+
+
+
+
+

8.11. 단항 연산자와 연산 대상 사이에 공백을 미삽입

+
+

[no-space-increament-decrement-operator]

+
+
+

단항 연산자와 연산 대상의 사이에는 공백을 삽입하지 않는다.

+
+
+
    +
  • +

    전위 연산자 : 연산자 뒤에 공백을 삽입하지 않는다.

    +
    +
      +
    • +

      전위 증감/감소 연산자 : ++,--

      +
      • +
    • +

      부호로 쓰이는 +, -

      +
      • +
    • +

      NOT 연산자 : ~, !

      +
      • +
    +
    +
    • +
  • +

    후위 연산자 : 연산자 앞에 공백을 삽입하지 않는다.

    +
    +
      +
    • +

      후위 증감/감소 연산자 : ++,--

      +
      • +
    +
    +
    • +
+
+
+
나쁜 예
+
+
int point = score[++ index] * rank -- * - 1;
+
+
+
+
좋은 예
+
+
int point = score[++index] * rank-- * -1;
+
+
+
+
+

8.12. 주석문 기호 전후의 공백 삽입

+
+

[space-around-comment]

+
+
+

주석의 전후에는 아래와 같이 공백을 삽입한다.

+
+
+
    +
  • +

    명령문과 같은 줄에 주석을 붙일 때 // 앞

    +
    • +
  • +

    주석 시작 기호 // 뒤

    +
    • +
  • +

    주석 시작 기호 /* 뒤

    +
    • +
  • +

    블록 주석을 한 줄로 작성시 종료 기호 */ 앞

    +
    • +
+
+
+
좋은 예
+
+
/*
+ * 공백 후 주석내용 시작
+ */
+
+System.out.print(true); // 주석 기호 앞 뒤로 공백
+
+/* 주석내용 앞에 공백, 뒤에도 공백 */
+
+
+
+
+
+
+

Appendix A: .editorconfig 파일 설정

+
+
+

.editorconfig 는 다양한 에디터와 IDE에서 공통적으로 지원하는 코드 스타일에 대한 설정 파일이다. +자세한 스펙은 https://editorconfig.org/ 에서 파악할 수 있다. +다양한 에디터로 파일을 고칠 때 같은 규칙을 참조할수 있도록 가급적 이 파일을 소스 저장소에서 올려서 공유하는 것을 권장한다.

+
+
+
`.editorconfig`의 예제
+
+
# top-most EditorConfig file
+root = true
+
+[*]
+# [encoding-utf8]
+charset = utf-8
+
+# [newline-lf]
+end_of_line = lf
+
+# [newline-eof]
+insert_final_newline = true
+
+[*.bat]
+end_of_line = crlf
+
+[*.java]
+# [indentation-tab]
+indent_style = tab
+
+# [4-spaces-tab]
+indent_size = 4
+tab_width = 4
+
+# [no-trailing-spaces]
+trim_trailing_whitespace = true
+
+[line-length-120]
+max_line_length = 120
+
+
+
+
+
+

Appendix B: Checkstyle 사용법

+
+
+

Checkstyle 은 코딩컨벤션 검사 도구이다. 이 가이드에서 안내하는 규칙을 검사하는 checkstyle 규칙 설정 파일을 제공한다.

+
+
+

B.1. 필수 버전

+
+

Checkstyle 8.24 버전 이상을 사용해야 한다. 빌드 도구와 IDE에서 권장한 버전을 쓰고 있는지 확인을 한다.

+
+
+
+

B.2. 규칙 설정 파일 다운로드

+
+

https://github.com/naver/hackday-conventions-java/blob/master/rule-config/naver-checkstyle-rules.xml 에서 다운로드한다.

+
+
+
+

B.3. 검사 실행

+
+

실제 프로젝트에서 쓸 때는 IDE나 빌드도구와 연동해서 사용하는것을 권장한다. 그러나 규칙 파일을 커스터마이징 했을 때에는 Checkstyle을 독립적으로 실행을 해서 IDE나 빌드스크립트와 연동하기 전에 먼저 테스트해 보기를 권장한다.

+
+
+

독립적으로 실행할 때는 +https://github.com/checkstyle/checkstyle/releases/ 에서 jar 파일을 다운로드하고 아래와 같이 실행한다.

+
+
+
checkstyle 독립실행
+
+
java -jar checkstyle-8.24-all.jar -c [규칙파일] [소스폴더]
+
+
+
+

naver-checkstyle-rules.xml을 수정 없이 사용할 때는 -DsuppressionFile 속성을 지정해야 한다. +예외선언 파일의 위치를 IDE와 Maven/Gradle 빌드 양쪽에서 참조하기 위해서 필요한 속성이다.

+
+
+
naver-checkstyle-rules.xml 독립 실행 사례
+
+
java -DsuppressionFile=naver-checkstyle-suppressions.xml -jar checkstyle-8.24-all.jar -c naver-checkstyle-rules.xml src
+
+
+
+

만약 검사 대상에서 제외할 파일이 없다면 제외 대상을 별도의 파일로 선언 을 참조해서 suppressionFile 과 관련된 선언을 삭제하고 위의 명령에서도 생략할 수 있다.

+
+
+
+

B.4. 관련 규칙 확인 방법

+
+

규칙 파일에서는 규칙의 ID를 주석으로 달았다. 경고 메시지에서도 규칙의 ID를 표시한다.

+
+
+
+
<!-- [1-line-package-import]-->
+<module name="NoLineWrap">
+    <property name="tokens" value="PACKAGE_DEF, IMPORT"/>
+        <message key="no.line.wrap"
+            value="[1-line-package-import] {0} statement should not be line-wrapped."/>
+</module>
+
+
+
+

규칙의 ID를 이 가이드에서 검색해서 해당 규칙을 찾는다. HTML문서에서는 #뒤에 규칙의 ID를 붙여서 바로 이동할 수도 있다. 예를 들면 [need-brace]에 규칙에 대한 설명은 http://docs.navercorp.com/coding-convention/java.html#need-braces 링크를 걸 수 있다. 온라인 코드 리뷰를 할 때도 이런 링크를 활용할 수 있다.

+
+
+
+

B.5. 검사할 수 없는 규칙

+
+

아래 규칙은 Checkstyle로 검사할 수 없다.

+
+
+ +
+
+
+

B.6. 검사 대상에서 제외하기

+
+

B.6.1. 제외 대상을 별도의 파일로 선언

+
+

Checkstyle에서는 검사대상에서 제외할 파일을 별도의 설정파일에서 지정할 수 있다.

+
+
+

naver-checkstyle-rules.xml의 설정에서는 suppressionFile 이라는 속성으로 naver-checkstyle-suppressions.xml 파일의 위치를 지정할 수 있도록 미리 설정되어 있다.

+
+
+
+
    <module name="SuppressionFilter">
+        <property name="file" value="${suppressionFile}"/>
+        <property name="optional" value="false"/>
+    </module>
+
+
+
+

굳이 예외로 지정할 파일이 없다면 naver-checkstyle-rules.xml에서 위의 선언은 삭제하고 사용한다.

+
+
+

suppressionFile 속성으로 참조할 파일은 naver-checkstyle-suppressions.xml 과 같은 이름으로 지정한다.

+
+
+
naver-checkstyle-suppressions.xml 선언의 예
+
+
<?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC
+"-//Puppy Crawl//DTD Suppressions 1.1//EN"
+"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+
+<suppressions>
+<suppress files="UserController.java" checks=".*"/>
+<suppress files="UserService.java" checks=".*"/>
+</suppressions>
+
+
+
+

파일명을 정규식으로 설정하는 것도 가능하다. 자세한 선언 방법은 http://checkstyle.sourceforge.net/config_filters.html#SuppressionFilter 을 참조한다.

+
+
+
+

B.6.2. 제외할 영역을 주석으로 표시

+
+

naver-checkstyle-rules.xml 의 설정에서는 아래와 같은 주석문을 인식한다.

+
+
+
    +
  • +

    // @checkstyle:off : 다음 행부터 검사 대상에서 제외

    +
    • +
  • +

    // @checkstyle:on : 다음 행부터 검사 대상에 포함

    +
    • +
  • +

    // @checkstyle:ignore // 같은 행의 소스를 검사하지 않음

    +
    • +
+
+
+
검사 대상에서 제외하는 주석 사용 예
+
+
public class MyCAO { // @checkstyle:ignore 외부에 배포된 라이브러리
+    public static final String SYSTEM_ID = "MD23D2";
+    // @checkstyle:off
+    public String CONNECT_URL;
+    public String USER_ID;
+    // @checkstyle:on
+}
+
+
+
+
+
+

B.7. 커스터마이징

+
+

`naver-checkstyle-rules.xml`에 정의된 규칙을 프로젝트에서 더 추가하거나, 수정해서 쓰려고 할 때 참고할만한 정보를 정리한다.

+
+
+

B.7.1. 대문자로 표기할 약어를 추가

+
+

'대문자로 표기할 약어 명시' 규칙에 따라서 대문자로 표기할 약어는 따로 명시해야 한다. naver-checkstyle-rules.xml 파일에서 allowedAbbreviations 속성에 해당 단어를 추가한다.

+
+
+
대문자로 표기할 약어를 설정 파일에 명시
+
+
<!-- [list-uppercase-abbr] -->
+<module name="AbbreviationAsWordInName">
+    <property name="ignoreFinal" value="false"/>
+    <property name="allowedAbbreviationLength" value="1"/>
+    <message key="abbreviation.as.word"
+    value="[list-uppercase-abbr] Abbreviation in name ''{0}'' must contain no more than {1}"/>
+    <property name="allowedAbbreviations" value="DAO,BO"/>
+</module>
+
+
+
+

설정 파일을 고치지 않으려면 `@checkstyle:ignore`와 같은 주석을 이용할 수도 있다.

+
+
+
+

B.7.2. 들여쓰기에 탭 대신 스페이스 사용

+
+

아래 선언을 naver-checkstyle-rules.xml 에서 삭제한다.

+
+
+
탭문자로 들여쓰도록 검사하는 규칙 선언
+
+
<!-- [indentation-tab] -->
+<module name="RegexpSinglelineJava">
+    <property name="format" value="^\t* "/>
+    <property name="message" value="[indentation-tab] Indent must use tab characters"/>
+    <property name="ignoreComments" value="true"/>
+</module>
+
+
+
+

대신 아래와 같이 탭문자가 포함되어 있을때 경고를 보내는 선언을 추가한다.

+
+
+
스페이스로 들여쓰도록 검사하는 규칙 선언
+
+
<module name="FileTabCharacter">
+    <property name="eachLine" value="true"/>
+</module>
+
+
+
+
+
+
+
+

Appendix C: 빌드 도구 설정

+
+
+

C.1. Maven

+
+

`pom.xml`에서 아래와 같은 선언을 추가한다.

+
+
+

C.1.1. 인코딩 지정

+
+

pom.xml`의 `<project/> 태그의 하위 요소로 아래와 같이 소스 파일의 인코딩을 UTF-8 로 명시한다.

+
+
+
+
<properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+</properties>
+
+
+
+

위의 속성값들은 maven-compiler-plugin 과 maven-resources-plugin 에서 기본값으로 참조된다. +<plugins/> 선언부에서 직접 encoding을 명시하고 있다면 위의 속성이 참조되지 않는다. +아래와 같은 경우이다.

+
+
+
Maven의 플러그인별 설정에서 인코딩 지정
+
+
<plugin>
+    <groupId>org.apache.maven.plugins</groupId>
+    <artifactId>maven-compiler-plugin</artifactId>
+    <version>3.1</version>
+    <configuration>
+        <source>1.8</source>
+        <target>1.8</target>
+        <encoding>UTF-8</encoding>
+    </configuration>
+</plugin>
+<plugin>
+    <groupId>org.apache.maven.plugins</groupId>
+    <artifactId>maven-resources-plugin</artifactId>
+    <version>2.7</version>
+    <configuration>
+        <encoding>UTF-8</encoding>
+    </configuration>
+</plugin>
+
+
+
+
+

C.1.2. editorconfig 플러그인 설정

+
+

https://github.com/ec4j/editorconfig-maven-plugin 을 참고한다.

+
+
+
+

C.1.3. Checkstyle 플러그인 설정

+
+

<build> 태그 아래에 <pluginManagement/> 선언에 maven-checkstyle-plugin의 버전과 checkstyle의 버전을 명시한다. +checkstyle의 버전은 반드시 8.24 이상으로 지정한다.

+
+
+

예외를 선언할 파일이 없다면 naver-checkstyle-suppressions.xml 과 관련된 설정은 생략해도 된다.

+
+
+
pluginManagement 선언
+
+
<pluginManagement>
+    <plugins>
+        <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-checkstyle-plugin</artifactId>
+            <version>3.1.1</version>
+            <configuration>
+                <configLocation>naver-checkstyle-rules.xml</configLocation>
+                <sourceDirectories>${project.build.sourceDirectories}</sourceDirectories>
+                <propertyExpansion>suppressionFile=./naver-checkstyle-suppressions.xml</propertyExpansion>
+            </configuration>
+            <dependencies>
+                <dependency>
+                    <groupId>com.puppycrawl.tools</groupId>
+                    <artifactId>checkstyle</artifactId>
+                    <version>8.24</version>
+                </dependency>
+            </dependencies>
+        </plugin>
+    </plugins>
+</pluginManagement>
+
+
+
+

<build> → <plugins> 태그 아래에 다음과 같은 선언을 추가한다.

+
+
+
plugin 선언
+
+
<plugin>
+    <groupId>org.apache.maven.plugins</groupId>
+    <artifactId>maven-checkstyle-plugin</artifactId>
+</plugin>
+
+
+
+

mvn checkstyle:checkstyle`로 실행하면 검사가 시작된다. `mvn site 명령으로 검사를 실행하고 싶다면 <reporting> → `<plugins>`태그 아래에 위의 선언을 추가한다.

+
+
+
+
+

C.2. Gradle

+
+

Gradle 버전 5.4.1 이상을 권장한다.

+
+
+

C.2.1. 인코딩 지정

+
+

Java plugin의 속성으로 인코딩을 지정한다. 아래와 같이 여러 방법이 가능하다.

+
+
+
java plugin의 속성에서 인코딩을 지정
+
+
plugins {
+    id 'java'
+}
+
+...
+
+// 방법1
+compileJava.options.encoding = 'UTF-8'
+compileTestJava.options.encoding = 'UTF-8'
+
+// 방법 2
+[compileJava, compileTestJava]*.options*.encoding = 'UTF-8'
+
+// 방법 3
+tasks.withType(Compile) {
+options.encoding = 'UTF-8'
+}
+
+
+
+
+

C.2.2. .editorconfig 플러그인 설정

+
+

editorconfig-gradle-plugin을 설정하면 .editorconfig 의 선언과 어긋나는 파일이 존재하면 빌드를 실패하게 만들수 있다. +아래와 같이 `build.gradle`에 선언한다.

+
+
+
+
plugins {
+    id 'org.ec4j.editorconfig' version '0.0.3'
+
+}
+editorconfig {
+excludes = ['build']
+}
+
+check.dependsOn editorconfigCheck
+
+
+
+
+

C.2.3. Checkstyle 플러그인 설정

+
+

아래와 같이 `build.gradle`에 선언한다.

+
+
+
+
plugins {
+    id 'checkstyle'
+}
+
+checkstyle {
+maxWarnings = 0 // 규칙이 어긋나는 코드가 하나라도 있을 경우 빌드 fail을 내고 싶다면 이 선언을 추가한다.
+configFile = file("${rootDir}/naver-checkstyle-rules.xml")
+configProperties = ["suppressionFile" : "${rootDir}/naver-checkstyle-suppressions.xml"]
+toolVersion ="8.24"  // checkstyle 버전 8.24 이상 선언
+}
+
+
+
+

예외를 선언할 파일이 없다면 naver-style-supressions.xml 관련 선언은 생략할 수 있다.

+
+
+
+
+
+
+

Appendix D: 편집기 설정

+
+
+

이 가이드의 규칙을 지키는데 도움이 되는 코드 편집기와 뷰어 설정 방법을 정리한다.

+
+
+

D.1. Eclipse

+
+

D.1.1. Organize Imports 설정

+
+

아래 규칙을 자동으로 지키도록 해준다.

+
+
+ +
+
+

아래와 같은 순서로 설정한다.

+
+
+
    +
  1. +

    importorder 설정 파일 다운로드

    +
    + +
    +
    2. +
  2. +

    Organize Imports 설정 화면으로 이동

    +
    +
      +
    • +

      Workspace 전역설정은 `Window > Preference > Java > Code style > Organize Imports`로 이동.

      +
      • +
    • +

      프로젝트별 설정은 `Porject > Properties > Java Code style > Organize Imports`로 이동.

      +
      • +
    +
    +
    3. +
  3. +

    `Organize Imports`의 항목 입력

    +
    +
      +
    • +

      Enable project specific settings(프로젝트별 설정의 경우) : 체크

      +
      • +
    • +

      Define the sorting order of import statement

      +
      +
        +
      • +

        [Import] 버튼을 클릭하여 `naver.importorder`파일 선택

        +
        • +
      +
      +
      • +
    • +

      Number of imports needed for .* : 99

      +
      • +
    • +

      Number of static imports needed for .* : 1

      +
      • +
    +
    +
    4. +
+
+
+

Eclipse Organize Imports

+
+
+
+

D.1.2. Formatter 설정

+
+

들여쓰기, 공백, 줄바꿈 규칙을 지키도록 도와준다.

+
+
+
    +
  1. +

    Formatter 설정 파일 다운로드

    +
    + +
    +
    2. +
  2. +

    Formatter 메뉴로 이동

    +
    +
      +
    • +

      Workspace 전역설정은 `Window > Preference > Java > Code style > Formatter`에서 이동한다.

      +
      • +
    • +

      프로젝트별 설정은 `Project > Properties > Java Code style > Formatter`로 이동한다.

      +
      • +
    +
    +
    3. +
  3. +

    Formatter 항목 설정

    +
    +
      +
    • +

      프로젝트별 설정의 경우 `Enable project specific settings`를 선택한다.

      +
      • +
    • +

      [Import] 버튼을 누른 후, 다운로드 한 naver-eclipse-formatter.xml 파일을 선택한다.

      +
      • +
    • +

      `[OK]`버튼을 누른다.

      +
      • +
    +
    +
    4. +
+
+
+

Formatter가 설정되면 코드 편집창에서 Ctrl + Shift + f 키로 코드 포멧을 맞출 수 있다. Formatter가 자동으로 맞춰주는 결과가 들지 않을 수도 있기 때문에 선택적으로 사용한다. 예를 들면 줄바꿈 후 들여쓰기를 최소기준인 한 단계보다 깊게 하고 싶을 경우 포멧터를 쓰지 않고 직접 탭문자를 입력할 수도 있다. Eclipse의 포멧터는 Checkstyle에서 검사하는 규칙보다 더 구체적인 규칙으로 코드를 맞춰 주기도 한다.

+
+
+
+

D.1.3. Save actions 활용

+
+

Eclipse에서는 `Ctrl + s`키로 파일을 저장할때 수행하는 동작을 지정할 수 있다. 아래와 같이 메뉴로 이동한다.

+
+
+
    +
  • +

    Workspace 전역 설정 : Window > Preference > Java > Editor Save Actions

    +
    • +
  • +

    프로젝트별 설정 : Project > Properties > Java Editor > Save Actions

    +
    • +
+
+
+

해당 메뉴에서 설정할 수 있는 동작은 아래와 같다.

+
+
+
    +
  • +

    Format source code : Formatter에 정의된 포메팅을 적용한다. 프로젝트의 상황에 따라서 선택한다.

    +
    • +
  • +

    Organize imports : `Ctrl + Shift + o`를 눌렀을 때와 동일한 동작을 한다.

    +
    • +
  • +

    Additional Actions : 아래 2개의 동작은 설정을 권장한다.

    +
    + +
    +
    • +
+
+
+
+

D.1.4. 포멧터 일괄 적용 활용

+
+

Cleanup 기능으로 프로젝트의 전체 소스에 포멧터를 일괄적으로 적용할 수 있다. +예를 들면 '공백으로 줄을 끝내지 않음' 규칙을 준수하기 위해 프로젝트의 모든 파일에서 줄 마지막의 공백을 일괄적으로 없애는 작업을 하는 경우에 사용할 수 있다.

+
+
+

Source > Clean up.. 메뉴로 실행한다. 여러 프로젝트에 반복적으로 수행해야할 작업의 그룹이 있다면, 수행할 작업을 별도의 프로파일로 빼서 정의할 수도 있다. 사전정의된 프로파일을 실행할때는 Use configured profiles`를 선택한다. `Use custom profile 을 선택하면 수행할 작업을 하나씩 선택할 수 있다.

+
+
+

Eclipose의 Cleanup 기능

+
+
+
+

D.1.5. Checkstyle 설정

+
+
플러그인 설치
+
+
    +
  1. +

    메뉴에서 `Help > Eclise Marketplace`에서 'Checkstyle plugin’으로 검색한다.

    +
    2. +
  2. +

    Eclipse Checkstyle plugin(eclipse-cs)를 찾아서 [Install] 버튼을 누른다.

    +
    3. +
+
+
+

이미 플러그인을 설치했다면 권장하는 버전이 설치되어 있는지 확인을 한다. Help > Installation Details 메뉴에서 이를 확인할 수 있다. +Eclipse Checkstyle plugin의 버전은 의존하는 checkstyle의 버전과 동일하게 표기되고 있다. `naver-checkstyle-rules.xml`을 수정없이 쓸 때는 Eclipse Checkstyle plugin의 버전도 8.24 이상인지 확인을 한다.

+
+
+

Eclipse Checkstyle plugin 설치

+
+
+
+
규칙 파일 불러오기
+
+
    +
  1. +

    Checkstyle 메뉴로 이동

    +
    +
      +
    • +

      여러 프로젝트에서 같은 파일을 활용할 때는 Workspace 전역 규칙으로 불러 올것을 권장한다. Window > Preference > Checkstyle 메뉴로 이동한다.

      +
      • +
    • +

      프로젝트별로 다른 설정을 쓸 때는 프로젝트별 설정을 해야한다. Project > Properties > Checkstyle 메뉴에서 Local Check Configurations 탭으로 이동한다.

      +
      • +
    +
    +
    2. +
  2. +

    Checkstyle 메뉴에서 설정파일 목록의 오른쪽에 있는 [New] 버튼을 누른다.

    +
    3. +
  3. +

    Checkstyle Configuration Properties 팝업창의 항목 입력

    +
    +
      +
    • +

      Type : External Configuration File 혹은 Project Relative Configuration 선택

      +
      • +
    • +

      Location : `[Browse]`버튼을 눌러서 `naver-checkstyle-rules.xml`를 찾아서 선택

      +
      • +
    • +

      Name : 인식할 수 있는 이름. `naver-checkstyle-rules`를 권장

      +
      • +
    • +

      Protect Checkstyle Configuration File : 체크

      +
      • +
    +
    +
    4. +
+
+
+
+
프로젝트별 검사 설정
+
+

Project > Properties > Checkstyle 메뉴에서 아래 항목을 설정한다.

+
+
+
    +
  • +

    Checkstyle active for this project : 체크

    +
    • +
  • +

    Write formatter/cleanup config (experimental!) : 체크하지 않음

    +
    • +
  • +

    Simple - use the following check configuration for all files : 앞 단계에서 설정한 naver-checkstyle-rules 선택

    +
    • +
  • +

    Excluding from checking

    +
    +
      +
    • +

      files outside sourcxe directories : 체크

      +
      • +
    • +

      derived (generated) files : 체크

      +
      • +
    +
    +
    • +
+
+
+
+
+

D.1.6. 공백 문자 보이기 설정

+
+

탭과 스페이스가 섞여 있는 프로젝트의 코드를 정리할 때는 탭과 스페이스를 눈에 보이게 표시한다. +Windows > Preferences > Editors > Text Editors 에서 Show whitespaces characters 를 선택한다.

+
+
+
+

D.1.7. 커스터마이징

+
+

이 가이드와 함께 제공되는 Eclipse의 설정파일이 프로젝트에서 재정의한 규칙과 맞지 않을 때 참고할만한 정보를 정리한다.

+
+
+
들여쓰기에 탭 대신 스페이스 사용
+
+

Eclipse는 들여쓰기로 4개 크기의 탭을 디폴트로 사용한다. naver-eclipse-formatter.xml에서도 동일하게 설정되어 있다.

+
+
+

만약 탭 대신 스페이스로 들여쓰기를 하려는 프로젝트에서는 아래와 같이 설정한다.

+
+
+
    +
  • +

    `Windows > Preferences > Editors > Text Editors`에 메뉴로 이동한다.

    +
    +
      +
    • +

      `Insert spaces for Tab`를 선택한다.

      +
      • +
    +
    +
    • +
+
+
+

naver-eclipse-formatter.xml에 반영하려면 tabulation.char 속성을 space 로 바꾼다.

+
+
+
Eclipse formatter 탭문자 설정
+
+
<setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/>
+
+
+
+
+
줄바꿈 후 추가 들여쓰기 단계 조정
+
+

Eclipse의 자동 포멧 기능을 적용했을 때 (단축키 Ctrl+Shift+f ) 적용되는 기준이다. +이 저장소에서 제공하는 naver-eclipse-formatter.xml 파일의 설정으로는 문장에서 ; 을 선언하기 전 중간에 줄바꿈을 했을 때 1단계의 들어쓰기가 추가된다.

+
+
+

이를 2단계로 바꾸려면 Java Code Style > Formatter > [Edit] > Line Wrapping > General settings 의 아래 항목을 조정한다.

+
+
+
    +
  • +

    Default indention for warpped lines: : 2

    +
    • +
  • +

    Default indention for array initalizers: : 2

    +
    • +
+
+
+

IntelliJ 줄바꿈 들여쓰기 설정

+
+
+

naver-eclipse-formatter.xml 에서는 continuation_indentation 관련 속성을 2로 바꾸면 위와 같은 효과가 있다.

+
+
+
Eclipse formatter에서 들어쓰기 단계 조정
+
+
<setting id="org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer" value="2"/>
+<setting id="org.eclipse.jdt.core.formatter.continuation_indentation" value="2"/>
+
+
+
+
+
+
+

D.2. IntelliJ

+
+

D.2.1. Formatter 적용

+
+

naver-intellij-formatter.xml 파일을 아래와 같이 적용한다.

+
+
+
    +
  1. +

    포멧터 다운로드

    +
    + +
    +
    2. +
  2. +

    Scheme 설정

    +
    +
      +
    • +

      File > Settings 메뉴로 이동한다. (단축키 Alt + Shift + S )

      +
      • +
    • +

      Editor > Code Style > Java 항목으로 이동한다.

      +
      • +
    • +

      Scheme 항목의 오른쪽에 있는 톱니바퀴 아이콘을 클릭한다.

      +
      • +
    • +

      Import Scheme > IntelliJ IDEA Code Style XML 을 선택한다.

      +
      • +
    • +

      IntelliJ Formatter Import

      +
      • +
    • +

      1에서 다운로드한 naver-intellij-formatter.xml 파일을 선택한후 [OK] 버튼을 누른다.

      +
      • +
    • +

      IntelliJ Formatter Import Scheme

      +
      • +
    • +

      TO 항목에는 naver-intellij-formatter.xml 안에 선언된 'Naver-Coding-Convnetion-v1.2’와 같은 이름이 디폴트로 나온다. 이 이름은 IntelliJ에서 전역적인 식별자가 되어서 다른 프로젝트에도 참조가 된다. 포멧터를 커스터 마이징했거나 프로젝트마다 다른 포멧터 설정을 쓴다면 이 스키마의 이름이 유일성 있게 인지되도록 수정한다.

      +
      • +
    • +

      Settings 레이어의 [OK] 버튼을 누른다.

      +
      • +
    +
    +
    3. +
+
+
+
+

D.2.2. 항목별 수동 설정

+
+

만약 이 가이드에서 제공하는 naver-intellij-formatter.xm 설정을 활용하기가 어려운 상황이라면 최소한 아래의 항목들은 직접 설정한다.

+
+
+
들여쓰기
+
+

'하드탭 사용' , '탭의 크기는 4개의 스페이스' 설정을 준수하기 위한 설정이다.

+
+
+
    +
  • +

    File > Settings > Editor > Code Style > Java 메뉴로 이동

    +
    +
      +
    • +

      User tab charactor : 선택

      +
      • +
    • +

      Tab Size, Indent : 4

      +
      • +
    +
    +
    • +
+
+
+
+
Import 구문
+
+

'static import에만 와일드 카드 허용', 'import 선언의 순서와 빈 줄 삽입' 설정을 준수하기 위한 설정이다.

+
+
+

File > Settings > Editors > Code Style > Java > Imports > Import Layout 로 이동해서 아래 항목을 설정한다.

+
+
+
    +
  • +

    General

    +
    +
      +
    • +

      Use single class import : 체크

      +
      • +
    • +

      Class count to use import with '*' : 99

      +
      • +
    • +

      Names count to use static import with '*' : 1

      +
      • +
    +
    +
    • +
  • +

    Import Layout

    +
    + +
    +
    • +
+
+
+

IntelliJ Imports 설정

+
+
+
+
줄바꿈 시 연산자 위치
+
+

'줄바꿈 허용 위치' 규칙에 따라 연산자 전에 줄바꿈을 해야한다. 자동 정렬 시에 이를 준수하기 위해서 아래와 같이 설정한다.

+
+
+
    +
  1. +

    File > Settings > Editors > Code Style > Java > Imports > Import Layout 로 이동한다.

    +
    2. +
  2. +

    Binary expressions 아래의 Operation sign on next line 항목을 선택한다.

    +
    3. +
+
+
+

IntelliJ Wrapping and Braces 설정

+
+
+
+
+

D.2.3. 파일의 마지막에 새줄 문자가 없는 경우 추가

+
+

파일의 마지막에는 새줄 규칙을 준수하기 위한 설정이다. +File > Settings > Editor > General 메뉴에서 Ensure line feed at file end on Save 를 선택한다.

+
+
+
+

D.2.4. 파일을 저장 할 때마다 포멧터 자동 적용

+
+

Save Actions plugin을 활용하면 파일을 저장하는 순간 포멧터를 자동 적용할 수 있다.

+
+
+
    +
  1. +

    File > Settings ( Ctrl + Alt + S ) > Plugins 메뉴로 이동

    +
    2. +
  2. +

    Marketplace 탭에서 'Save Actions' 로 검색

    +
    3. +
  3. +

    Save Actions' plugin의 상세 설명 화면에서 `[Install] 버튼 클릭

    +
    4. +
  4. +

    IntelliJ를 재시작

    +
    5. +
  5. +

    File > Settings > Other Settions > Save Actions 메뉴로 이동

    +
    6. +
  6. +

    아래 항목을 체크

    +
    +
      +
    • +

      Activate save actions on save

      +
      • +
    • +

      Optimize imoprts

      +
      • +
    • +

      Refomat file

      +
      • +
    +
    +
    7. +
+
+
+
+

D.2.5. 일괄 변환

+
+

프로젝트의 홈디렉토리에 커서를 놓은채로 아래의 메뉴를 실행하면 프로젝트의 모든 소스에 해당 설정을 일괄 적용한다.

+
+
+
    +
  • +

    File > Line Separators

    +
    • +
  • +

    Code > Reformat Code

    +
    • +
  • +

    Code > Auto-Indent Lines

    +
    • +
  • +

    Code > Optimize Imports

    +
    • +
+
+
+
+

D.2.6. Checkstyle 설정

+
+
플러그인 설치
+
+
    +
  1. +

    File > Settings > Plugins 메뉴로 이동한다.

    +
    2. +
  2. +

    [Browse Reposities..] 버튼 클릭

    +
    3. +
  3. +

    'Checkstyle’의 단어로 검색해서 CheckStyle-IDEA 플러그인을 찾은 후 [Install] 버튼을 클릭

    +
    4. +
+
+
+

이미 플러그인이 설치되어 있다면 권장하는 버전인지 확인을 한다. +CheckStyle-IDEA의 사용여부를 선택하는 화면에서 'This plugin provides both real-time and on-demand scanning of Java files with CheckStyle 8.24 from within IDEA.'와 같은 문구로 Checkstyle의 버전을 알려준다. +naver-checkstyle-rules.xml 을 수정없이 쓰려면 Checkstyle 8.24이상을 쓰는 CheckStyle-IDEA의 버전이 설치되어 있어야한다.

+
+
+

CheckStyle-IDEA

+
+
+
+
검사 설정
+
+
    +
  1. +

    File > Settings > Other Settings > Checkstyle 메뉴에서 아래 항목들을 설정 한다

    +
    +
      +
    • +

      Checkstyle versions : 8.24 이상 선택. 디폴트 설정과 다르다면 'Apply' 버튼을 한번 눌러준다.

      +
      • +
    • +

      Scan scope : All sources including tests 선택

      +
      • +
    • +

      Treat Checkstyle errors as warnings : 체크

      +
      • +
    +
    +
    2. +
  2. +

    File > Settings > Other Settins > Checkstyle 메뉴로 이동한다.

    +
    3. +
  3. +

    [+] 버튼을 누르면 나오는 입력창에서 아래 항목을 입력한다.

    +
    +
      +
    • +

      Description : 식별할 수 있는 이름. Naver Checkstyle Rules [버전] 를 권장한다. 프로젝트별로 커스터마이징을 했다면 식별하기 쉽게 프로젝트 이름 등을 붙인다.

      +
      • +
    • +

      Use a Local Checkstyle File : 선택하고 [Browse] 버튼을 눌러서 `naver-checkstyle-rules.xml`을 지정한다.

      +
      • +
    • +

      [Next] 버튼을 누른다.

      +
      • +
    +
    +
    4. +
  4. +

    suppressionFile 변수를 설정하라는 화면이 나오면

    +
    +
      +
    • +

      IntelliJ Checkstyle config_loc

      +
      • +
    • +

      검사 예외를 지정하지 않는다면 [Next] 버튼을 누른다.

      +
      • +
    • +

      예외 정책을 지정할 naver-checkstyle-suppressions.xml 이 있을 경우에는 파일의 위치를 입력한 후 [Next] 버튼을 누른다. 프로젝트 루트에서 상대경로로 입력해도 된다.

      +
      • +
    +
    +
    5. +
  5. +

    naver-checkstyle-rules 규칙을 앞의 체크박스를 선택한다.

    +
    +
      +
    • +

      IntelliJ Checkstyle 설정

      +
      • +
    +
    +
    6. +
+
+
+ + + + + +
+
Warning
+		 +Checkstyle의 상위 버전에서 하위 호환성으로 인한 문제가 생길 경우 Checkstyle versions 항목을 8.24 로 고정하면 naver-checkstyle-rules.xml 을 사용할 수 있다. +
+
+
+
+
+

D.2.7. 공백 문자 보이기 설정

+
+

탭과 스페이스가 섞여 있는 프로젝트의 코드를 정리할 때는 탭과 스페이스를 눈에 보이게 표시한다. +File > Settings > Editor > General > Appearance`에서 `Show whitespaces`를 선택한다. +하위 분류에서 `Leading, Inner,Trailing 을 선택한다.

+
+
+
+

D.2.8. 커스터마이징

+
+

이 가이드와 함께 제공되는 IntelliJ의 설정파일이 프로젝트에서 재정의한 규칙과 맞지 않을 때 참고할만한 정보를 정리한다.

+
+
+
들여쓰기에 탭 대신 스페이스 사용
+
+

이 가이드의 규칙과 다르게 탭대신 스페이스로 들여쓰기를 하고 싶다면 아래와 같이 설정한다.

+
+
+
    +
  1. +

    File > Settings > Editor > Code Style > Java 메뉴로 이동한다.

    +
    2. +
  2. +

    Tabs and Indents 탭으로 이동해서 아래 항목을 입력한다.

    +
    +
      +
    • +

      Use tab charactor : 미선택

      +
      • +
    • +

      Tab size : 4

      +
      • +
    +
    +
    3. +
+
+
+
+
줄바꿈 후 추가 들여쓰기 단계 조정
+
+

IntelliJ의 자동 포멧 기능을 적용했을 때 (단축키 Ctrl+Shift+f ) 적용되는 기준이다. +이 저장소에서 제공하는 naver-intellij-formatter.xml 파일의 설정으로는 문장에서 ; 을 선언하기 전 중간에 줄바꿈을 했을 때 1단계의 들어쓰기가 추가된다.

+
+
+

이를 2단계로 바꾸려면 아래와 같이 설정한다.

+
+
+
    +
  1. +

    File > Settings > Editor > Code Style > Java 메뉴로 이동한다.

    +
    2. +
  2. +

    Tabs and Indents 탭으로 이동한다.

    +
    3. +
  3. +

    Continuation ident: 항목을 8로 입력한다.

    +
    4. +
+
+
+

IntelliJ Indents 설정

+
+
+

naver-intellij-formatter.xml 파일에서는 CONTINUATION_INDENT_SIZE 속성을 8로 선언해서 반영할 수 있다.

+
+
+
IntelliJ formatter에서 들어쓰기 단계 조정
+
+
    <indentOptions>
+        <option name="CONTINUATION_INDENT_SIZE" value="8" />
+        <option name="USE_TAB_CHARACTER" value="true" />
+    </indentOptions>
+
+
+
+
+
+
+

D.3. VI

+
+

D.3.1. 탭의 크기 지정

+
+

Unix/Linux는 1탭이 8자리인데 이는 이 가이드의 탭의 크기는 4개의 스페이스 규칙에 맞지 않는다. +별다른 설정없이 Java 소스를 vi에서 확인하는 경우에는 혼란을 유발할 수 있다. +[home]/.vimrc 파일에서 다음을 설정한다.

+
+
+
+
set tabstop=4
+set shiftwidth=4
+
+
+
+

tabstop은 \t`문자를 몇개의 크기로 보여줄지를, shiftwidth는 `>>, << 키를 이용할 때 들어가는 간격을 지정한다.

+
+
+
+

D.3.2. 한 줄 최대길이

+
+

'최대 줄 너비는 120' 규칙을 준수하기 위해 ‘textwidth’ 옵션을 사용한다.

+
+
+
+
set textwidth=120
+
+
+
+
+
+

D.4. Github

+
+

Github.com과 Github Enterprise를 사용할 때도 탭의 크기 등을 맞춰야 IDE를 쓸 때와 일관된 레이아웃으로 코드 리뷰를 할 수 있다. +.editorconfig 파일을 프로젝트 최상위 디렉토리에 올리면 해당 저장소의 코드 보기/ 편집 기능에서 일괄적으로 탭의 크기 등이 설정된다. +.editorconfig 파일 설정 를 참고한다.

+
+
+

만약 저장소 전체 설정을 하기 어려울 경우, 코드를 보는 URL 뒤에 `?ts=4`파라미터를 붙이면 탭의 크기를 지정할 수 있다. +예를 들면 https://github.com/naver/ngrinder/blob/master/ngrinder-controller/src/test/java/org/ngrinder/AbstractNGrinderTransactionalTest.java?ts=4 와 같은 식이다.

+
+
+
+
+
\ No newline at end of file diff --git a/ideas/notes.md b/ideas/notes.md new file mode 100644 index 00000000..9af3b863 --- /dev/null +++ b/ideas/notes.md @@ -0,0 +1,66 @@ +# 서버 집체 교육 사전 과제 + +## 무엇을 하는가? +- 기본기 등의 요구사항을 충족한 숫자 야구 구현하기 + +## 왜 하는가? + +- 유지보수·확장성·협업을 고려한 코드 작성을 통해 학습자의 수준을 평가하기 위함 + +## 무엇을 지켜야 하는가? +1. 기능 요구사항 + - 기능 목록을 만든다 + - 기능 단위로 commit한다 + - 기본적으로 1부터 9까지 서로 다른 수로 이루어진 3자리의 수를 맞추는 게임이다. + - 같은 수가 같은 자리에 있으면 스트라이크, 다른 자리에 있으면 볼, 같은 수가 전혀 없으면 포볼 또는 낫싱이란 힌트를 + 얻고, 그 힌트를 이용해서 먼저 상대방(컴퓨터)의 수를 맞추면 승리한다. + - [예] 상대방(컴퓨터)의 수가 425일 때, 123을 제시한 경우 : 1스트라이크, 456을 제시한 경우 : 1스트라이크 1볼, + 789를 제시한 경우 : 낫싱 + - 위 숫자 야구게임에서 상대방의 역할을 컴퓨터가 한다. 컴퓨터는 1에서 9까지 서로 다른 임의의 수 3개를 선택한다. 게임 플레이어는 컴퓨터가 생각하고 있는 3개의 숫자를 입력하고, 컴퓨터는 입력한 숫자에 대한 결과를 출력한다. + - 이 같은 과정을 반복해 컴퓨터가 선택한 3개의 숫자를 모두 맞히면 게임이 종료된다. + - 게임을 종료한 후 게임을 다시 시작하거나 완전히 종료할 수 있다. + - 사용자가 잘못된 값을 입력할 경우 [ERROR]로 시작하는 에러 메시지를 출력하고 게임을 계속 진행할 수 있어야 한다. +2. 프로그래밍 요구사항 + 1. 제약사항 + - 자바 코드 컨벤션을 지키면서 프로그래밍한다. + - https://naver.github.io/hackday-conventions-java/ + - indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용한다. + - 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다. + - 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메소드)를 분리하면 된다. + - 자바 8에 추가된 stream api를 사용하지 않고 구현해야 한다. 단, 람다는 사용 가능하다. + - else 예약어를 쓰지 않는다. + - 힌트: if 조건절에서 값을 return하는 방식으로 구현하면 else를 사용하지 않아도 된다. + - else를 쓰지 말라고 하니 switch/case로 구현하는 경우가 있는데 switch/case도 허용하지 않는다. + - 함수(또는 메소드)의 길이가 15라인을 넘어가지 않도록 구현한다. + - 함수(또는 메소드)가 한 가지 일만 잘 하도록 구현한다. + + 2. 단위 테스트 + - 도메인 로직에 단위 테스트를 구현해야 한다. 단, UI(System.out, System.in, Scanner) 로직은 제외 + - 핵심 로직을 구현하는 코드와 UI를 담당하는 로직을 분리해 구현한다. + - 힌트는 MVC 패턴 기반으로 구현한 후 View, Controller를 제외한 Model에 대한 단위 테스트를 추가하는 것에 집중한다. + - JUnit5와 AssertJ 사용법에 익숙하지 않은 개발자는 첨부한 "학습테스트를 통해 JUnit 학습하기.pdf" 문서를 참고해 사용법을 학습한 후 JUnit5 기반 단위 테스트를 구현한다. + +3. 과제 진행 요구사항 + - 미션은 https://github.com/next-step/java-baseball-precourse 저장소를 fork/clone해 시작한다. + - 기능을 구현하기 전에 java-baseball-precourse/README.md 파일에 구현할 기능 목록을 정리해 추가한다. + - git의 commit 단위는 앞 단계에서 README.md 파일에 정리한 기능 목록 단위 또는 의미있는 단위로 Commit한다. + - [AngularJS Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153) 참고해 commit log를 남기려고 노력해 본다. + - 과제 진행 및 제출 방법은 [프리코스 과제 제출](https://github.com/next-step/nextstep-docs/blob/master/precourse) 문서를 참고한다. + +## 제출 방법 + +- repo fork +- branch 생성 +- 개발 완료 후 commit&push +- 깃헙 PR 작성 +- hello@nextstep.camp로 이메일 작성 + ```text + 제목 : [$이름] 프리코스 미션 제출합니다. + 내용 : + 다음 두 개의 정보를 반드시 포함해 메일을 보낸다. + + * 교육 과정 신청시 email 주소: + * Pull Request URL: + + 미션을 진행하면서 느끼고, 배운점, 많은 시간을 투자한 부분 등도 포함하면 더 좋을 것 같아요. + ``` \ No newline at end of file diff --git a/ideas/plans.md b/ideas/plans.md new file mode 100644 index 00000000..b78ce74d --- /dev/null +++ b/ideas/plans.md @@ -0,0 +1,145 @@ +# 개발 계획 (상세) + +## 기본 원칙 +- 기능 단위로 구현하고 기능 단위로 커밋한다. +- AngularJS Commit Message Conventions 형식: `(): ` +- 자바 컨벤션 준수, indent depth 2 이하, stream api 미사용, else/switch 미사용, 메소드 15라인 이하. +- UI와 도메인 로직 분리, MVC 기반으로 모델에 단위 테스트 집중. +- JUnit5 + AssertJ 사용. + +## 준비 작업 +- `README.md`에 기능 목록을 먼저 정리한다. +- 패키지 구조 확정: `controller`, `view`, `domain`, `util` (필요 시 `dto`). + +## 파일/폴더 구조 (초안) +- `src/main/java/.../Application.java` +- `src/main/java/.../controller/GameController.java` +- `src/main/java/.../view/InputView.java` +- `src/main/java/.../view/OutputView.java` +- `src/main/java/.../domain/ComputerNumbers.java` +- `src/main/java/.../domain/GuessNumbers.java` +- `src/main/java/.../domain/Result.java` +- `src/main/java/.../domain/ResultCalculator.java` +- `src/main/java/.../domain/InputValidator.java` +- `src/main/java/.../util/RandomNumberGenerator.java` +- `src/test/java/.../domain/ComputerNumbersTest.java` +- `src/test/java/.../domain/GuessNumbersTest.java` +- `src/test/java/.../domain/ResultCalculatorTest.java` +- `src/test/java/.../domain/InputValidatorTest.java` + +## 클래스 책임 및 메소드 스케치 + +### Application +- `public static void main(String[] args)`에서 `GameController` 실행. + +### GameController +- 책임: 게임 루프, 재시작 흐름, 예외 처리. +- 메소드 예시 + - `void run()` + - `void playGame()` + - `boolean askRestart()` + - `GuessNumbers readGuess()` + +### InputView / OutputView +- InputView: 입력만 담당. + - `String readGuessInput()` + - `String readRestartInput()` +- OutputView: 출력만 담당. + - `void printResult(Result result)` + - `void printStartMessage()` + - `void printEndMessage()` + - `void printError(String message)` + +### ComputerNumbers +- 책임: 컴퓨터 숫자 보관/생성. +- 메소드 예시 + - `static ComputerNumbers generate(RandomNumberGenerator generator)` + - `List getNumbers()` + +### GuessNumbers +- 책임: 사용자 입력 숫자 값 객체. +- 메소드 예시 + - `static GuessNumbers from(String input)` + - `List getNumbers()` + +### InputValidator +- 책임: 입력 검증, 잘못된 경우 `IllegalArgumentException` with `[ERROR]`. +- 메소드 예시 + - `void validateGuess(String input)` + - `void validateRestart(String input)` + +### Result +- 책임: 스트라이크/볼 상태 값 객체. +- 메소드 예시 + - `int getStrikes()` + - `int getBalls()` + - `boolean isNothing()` + - `boolean isThreeStrikes()` + +### ResultCalculator +- 책임: 정답과 입력 비교. +- 메소드 예시 + - `Result calculate(ComputerNumbers answer, GuessNumbers guess)` + +### RandomNumberGenerator +- 책임: 1~9 중 중복 없는 3자리 생성. +- 메소드 예시 + - `List generate()` + +## 테스트 설계 (도메인 중심) + +### ComputerNumbersTest +- 생성된 숫자 개수 3개. +- 1~9 범위 내. +- 중복 없음. + +### GuessNumbersTest +- 정상 입력: "123" -> 3개 숫자. +- 비정상 입력: 길이 3 아님, 숫자 아님, 중복 있음, 0 포함. + +### InputValidatorTest +- `validateGuess`가 잘못된 입력에 대해 `[ERROR]` 메시지 포함 예외 발생. +- `validateRestart`는 "1" 또는 "2"만 허용. + +### ResultCalculatorTest +- 정답 425 vs 입력 123 -> 1S 0B. +- 정답 425 vs 입력 456 -> 1S 1B. +- 정답 425 vs 입력 789 -> 0S 0B. +- 3스트라이크 판정. + +## 기능 단위 개발 계획 (커밋 단위) + +### 1. 기능 목록 정리 +- `README.md`에 기능 목록 작성. +- 커밋: `docs(readme): add feature checklist` + +### 2. 도메인 뼈대 + 유틸 +- `RandomNumberGenerator`, `ComputerNumbers`, `GuessNumbers` 스켈레톤. +- 커밋: `feat(domain): add core number models` + +### 3. 결과 계산 로직 +- `Result`, `ResultCalculator` 구현. +- 커밋: `feat(domain): add result calculation` + +### 4. 입력 검증 로직 +- `InputValidator` 구현, 예외 메시지 포맷 통일. +- 커밋: `feat(domain): add input validation` + +### 5. MVC 게임 흐름 +- `InputView`, `OutputView`, `GameController`, `Application` 구현. +- 재시작/종료 흐름 구현. +- 커밋: `feat(controller): implement game loop` + +### 6. 모델 단위 테스트 +- 도메인 테스트 작성. +- 커밋: `test(domain): add unit tests` + +### 7. 규칙 리팩터링 +- 메소드 15라인 이하, indent depth 2 이하, else/switch 제거 확인. +- 커밋: `refactor: enforce coding constraints` + +## 커밋 규칙 예시 +- docs: 문서/기능 목록 +- feat: 기능 구현 +- test: 테스트 추가 +- refactor: 구조 개선/규칙 준수 리팩터링 diff --git a/src/main/java/camp/nextstep/edu/baseball/Application.java b/src/main/java/camp/nextstep/edu/baseball/Application.java new file mode 100644 index 00000000..0828f8f1 --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/Application.java @@ -0,0 +1,21 @@ +package camp.nextstep.edu.baseball; + +import camp.nextstep.edu.baseball.controller.GameController; +import camp.nextstep.edu.baseball.domain.ResultCalculator; +import camp.nextstep.edu.baseball.domain.RestartValidator; +import camp.nextstep.edu.baseball.util.RandomNumberGenerator; +import camp.nextstep.edu.baseball.view.InputView; +import camp.nextstep.edu.baseball.view.OutputView; + +public class Application { + public static void main(String[] args) { + GameController controller = new GameController( + new InputView(), + new OutputView(), + new RestartValidator(), + new ResultCalculator(), + new RandomNumberGenerator() + ); + controller.run(); + } +} diff --git a/src/main/java/camp/nextstep/edu/baseball/controller/GameController.java b/src/main/java/camp/nextstep/edu/baseball/controller/GameController.java new file mode 100644 index 00000000..21c12acb --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/controller/GameController.java @@ -0,0 +1,73 @@ +package camp.nextstep.edu.baseball.controller; + +import camp.nextstep.edu.baseball.domain.ComputerNumbers; +import camp.nextstep.edu.baseball.domain.GuessNumbers; +import camp.nextstep.edu.baseball.domain.RestartValidator; +import camp.nextstep.edu.baseball.domain.Result; +import camp.nextstep.edu.baseball.domain.ResultCalculator; +import camp.nextstep.edu.baseball.util.RandomNumberGenerator; +import camp.nextstep.edu.baseball.view.InputView; +import camp.nextstep.edu.baseball.view.OutputView; + +public class GameController { + private final InputView inputView; + private final OutputView outputView; + private final RestartValidator restartValidator; + private final ResultCalculator calculator; + private final RandomNumberGenerator generator; + + public GameController(InputView inputView, OutputView outputView, RestartValidator restartValidator, + ResultCalculator calculator, RandomNumberGenerator generator) { + this.inputView = inputView; + this.outputView = outputView; + this.restartValidator = restartValidator; + this.calculator = calculator; + this.generator = generator; + } + + public void run() { + boolean running = true; + while (running) { + playGame(); + running = askRestart(); + } + } + + private void playGame() { + ComputerNumbers answer = ComputerNumbers.generate(generator); + while (true) { + GuessNumbers guess = readGuess(); + Result result = calculator.calculate(answer, guess); + outputView.printResult(result); + if (result.isThreeStrikes()) { + outputView.printEndMessage(); + return; + } + } + } + + private GuessNumbers readGuess() { + while (true) { + outputView.printGuessPrompt(); + String input = inputView.readLine(); + try { + return GuessNumbers.from(input); + } catch (IllegalArgumentException e) { + outputView.printError(e.getMessage()); + } + } + } + + private boolean askRestart() { + while (true) { + outputView.printRestartPrompt(); + String input = inputView.readLine(); + try { + restartValidator.validateRestart(input); + return "1".equals(input); + } catch (IllegalArgumentException e) { + outputView.printError(e.getMessage()); + } + } + } +} diff --git a/src/main/java/camp/nextstep/edu/baseball/domain/ComputerNumbers.java b/src/main/java/camp/nextstep/edu/baseball/domain/ComputerNumbers.java new file mode 100644 index 00000000..48fb46ed --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/domain/ComputerNumbers.java @@ -0,0 +1,21 @@ +package camp.nextstep.edu.baseball.domain; + +import camp.nextstep.edu.baseball.util.RandomNumberGenerator; +import java.util.ArrayList; +import java.util.List; + +public class ComputerNumbers { + private final List numbers; + + private ComputerNumbers(List numbers) { + this.numbers = numbers; + } + + public static ComputerNumbers generate(RandomNumberGenerator generator) { + return new ComputerNumbers(generator.generate()); + } + + public List getNumbers() { + return new ArrayList<>(numbers); + } +} diff --git a/src/main/java/camp/nextstep/edu/baseball/domain/ErrorMessages.java b/src/main/java/camp/nextstep/edu/baseball/domain/ErrorMessages.java new file mode 100644 index 00000000..0313062d --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/domain/ErrorMessages.java @@ -0,0 +1,8 @@ +package camp.nextstep.edu.baseball.domain; + +public final class ErrorMessages { + public static final String INVALID_INPUT = "[ERROR] 잘못된 입력입니다."; + + private ErrorMessages() { + } +} diff --git a/src/main/java/camp/nextstep/edu/baseball/domain/GuessNumbers.java b/src/main/java/camp/nextstep/edu/baseball/domain/GuessNumbers.java new file mode 100644 index 00000000..d47d7d3b --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/domain/GuessNumbers.java @@ -0,0 +1,82 @@ +package camp.nextstep.edu.baseball.domain; + +import java.util.ArrayList; +import java.util.List; + +public class GuessNumbers { + private static final int GUESS_LENGTH = 3; + + private final List numbers; + + private GuessNumbers(List numbers) { + this.numbers = numbers; + } + + public static GuessNumbers from(String input) { + validate(input); + return new GuessNumbers(parse(input)); + } + + public List getNumbers() { + return new ArrayList<>(numbers); + } + + private static void validate(String input) { + validateNotNullOrEmpty(input); + validateLength(input); + validateDigitsOnly(input); + validateNoZero(input); + validateNoDuplicate(input); + } + + private static List parse(String input) { + List numbers = new ArrayList<>(); + for (int i = 0; i < input.length(); i++) { + numbers.add(Character.getNumericValue(input.charAt(i))); + } + return numbers; + } + + private static void validateNotNullOrEmpty(String input) { + if (input == null || input.isEmpty()) { + throw error(); + } + } + + private static void validateLength(String input) { + if (input.length() != GUESS_LENGTH) { + throw error(); + } + } + + private static void validateDigitsOnly(String input) { + for (int i = 0; i < input.length(); i++) { + if (!Character.isDigit(input.charAt(i))) { + throw error(); + } + } + } + + private static void validateNoZero(String input) { + for (int i = 0; i < input.length(); i++) { + if (input.charAt(i) == '0') { + throw error(); + } + } + } + + private static void validateNoDuplicate(String input) { + boolean[] used = new boolean[10]; + for (int i = 0; i < input.length(); i++) { + int number = Character.getNumericValue(input.charAt(i)); + if (used[number]) { + throw error(); + } + used[number] = true; + } + } + + private static IllegalArgumentException error() { + return new IllegalArgumentException(ErrorMessages.INVALID_INPUT); + } +} diff --git a/src/main/java/camp/nextstep/edu/baseball/domain/RestartValidator.java b/src/main/java/camp/nextstep/edu/baseball/domain/RestartValidator.java new file mode 100644 index 00000000..01f780ca --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/domain/RestartValidator.java @@ -0,0 +1,21 @@ +package camp.nextstep.edu.baseball.domain; + +public class RestartValidator { + + public void validateRestart(String input) { + validateNotNullOrEmpty(input); + if (!"1".equals(input) && !"2".equals(input)) { + throw error(); + } + } + + private void validateNotNullOrEmpty(String input) { + if (input == null || input.isEmpty()) { + throw error(); + } + } + + private IllegalArgumentException error() { + return new IllegalArgumentException(ErrorMessages.INVALID_INPUT); + } +} diff --git a/src/main/java/camp/nextstep/edu/baseball/domain/Result.java b/src/main/java/camp/nextstep/edu/baseball/domain/Result.java new file mode 100644 index 00000000..e24f2114 --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/domain/Result.java @@ -0,0 +1,27 @@ +package camp.nextstep.edu.baseball.domain; + +public class Result { + private final int strikes; + private final int balls; + + public Result(int strikes, int balls) { + this.strikes = strikes; + this.balls = balls; + } + + public int getStrikes() { + return strikes; + } + + public int getBalls() { + return balls; + } + + public boolean isNothing() { + return strikes == 0 && balls == 0; + } + + public boolean isThreeStrikes() { + return strikes == 3; + } +} diff --git a/src/main/java/camp/nextstep/edu/baseball/domain/ResultCalculator.java b/src/main/java/camp/nextstep/edu/baseball/domain/ResultCalculator.java new file mode 100644 index 00000000..90fa5cc1 --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/domain/ResultCalculator.java @@ -0,0 +1,40 @@ +package camp.nextstep.edu.baseball.domain; + +import java.util.List; + +public class ResultCalculator { + public Result calculate(ComputerNumbers answer, GuessNumbers guess) { + List answerNumbers = answer.getNumbers(); + List guessNumbers = guess.getNumbers(); + int strikes = countStrikes(answerNumbers, guessNumbers); + int balls = countBalls(answerNumbers, guessNumbers); + return new Result(strikes, balls); + } + + private int countStrikes(List answer, List guess) { + int strikes = 0; + for (int i = 0; i < answer.size(); i++) { + if (isStrike(answer, guess, i)) { + strikes++; + } + } + return strikes; + } + + private int countBalls(List answer, List guess) { + int balls = 0; + for (int i = 0; i < guess.size(); i++) { + if (isStrike(answer, guess, i)) { + continue; + } + if (answer.contains(guess.get(i))) { + balls++; + } + } + return balls; + } + + private boolean isStrike(List answer, List guess, int index) { + return answer.get(index).equals(guess.get(index)); + } +} diff --git a/src/main/java/camp/nextstep/edu/baseball/util/RandomNumberGenerator.java b/src/main/java/camp/nextstep/edu/baseball/util/RandomNumberGenerator.java new file mode 100644 index 00000000..8351740a --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/util/RandomNumberGenerator.java @@ -0,0 +1,33 @@ +package camp.nextstep.edu.baseball.util; + +import java.util.ArrayList; +import java.util.List; +import java.util.Random; + +public class RandomNumberGenerator { + private static final int SIZE = 3; + private static final int MIN = 1; + private static final int MAX = 9; + + private final Random random; + + public RandomNumberGenerator() { + this(new Random()); + } + + RandomNumberGenerator(Random random) { + this.random = random; + } + + public List generate() { + List numbers = new ArrayList<>(); + while (numbers.size() < SIZE) { + int candidate = random.nextInt(MAX) + MIN; + if (numbers.contains(candidate)) { + continue; + } + numbers.add(candidate); + } + return numbers; + } +} diff --git a/src/main/java/camp/nextstep/edu/baseball/view/InputView.java b/src/main/java/camp/nextstep/edu/baseball/view/InputView.java new file mode 100644 index 00000000..1fac2a5f --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/view/InputView.java @@ -0,0 +1,11 @@ +package camp.nextstep.edu.baseball.view; + +import java.util.Scanner; + +public class InputView { + private final Scanner scanner = new Scanner(System.in); + + public String readLine() { + return scanner.nextLine(); + } +} diff --git a/src/main/java/camp/nextstep/edu/baseball/view/OutputView.java b/src/main/java/camp/nextstep/edu/baseball/view/OutputView.java new file mode 100644 index 00000000..9607049e --- /dev/null +++ b/src/main/java/camp/nextstep/edu/baseball/view/OutputView.java @@ -0,0 +1,53 @@ +package camp.nextstep.edu.baseball.view; + +import camp.nextstep.edu.baseball.domain.Result; + +public class OutputView { + public void printGuessPrompt() { + System.out.print("숫자를 입력해주세요 : "); + } + + public void printRestartPrompt() { + System.out.print("게임을 새로 시작하려면 1, 종료하려면 2를 입력하세요."); + } + + public void printResult(Result result) { + if (result.isNothing()) { + System.out.println("낫싱"); + return; + } + System.out.println(buildResultMessage(result)); + } + + public void printEndMessage() { + System.out.println("3개의 숫자를 모두 맞히셨습니다! 게임 끝"); + } + + public void printError(String message) { + System.out.println(message); + } + + private String buildResultMessage(Result result) { + StringBuilder message = new StringBuilder(); + appendStrikes(message, result.getStrikes()); + appendBalls(message, result.getBalls()); + return message.toString(); + } + + private void appendStrikes(StringBuilder message, int strikes) { + if (strikes == 0) { + return; + } + message.append(strikes).append("스트라이크"); + } + + private void appendBalls(StringBuilder message, int balls) { + if (balls == 0) { + return; + } + if (message.length() > 0) { + message.append(" "); + } + message.append(balls).append("볼"); + } +} diff --git a/src/test/java/camp/nextstep/edu/baseball/domain/ComputerNumbersTest.java b/src/test/java/camp/nextstep/edu/baseball/domain/ComputerNumbersTest.java new file mode 100644 index 00000000..89584f7a --- /dev/null +++ b/src/test/java/camp/nextstep/edu/baseball/domain/ComputerNumbersTest.java @@ -0,0 +1,66 @@ +package camp.nextstep.edu.baseball.domain; + +import camp.nextstep.edu.baseball.util.RandomNumberGenerator; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThat; + +class ComputerNumbersTest { + + @Test + void generateReturnsThreeDistinctNumbersInRange() { + ComputerNumbers numbers = ComputerNumbers.generate(new FixedGenerator(seedNumbers())); + List values = numbers.getNumbers(); + + assertThat(values).hasSize(3); + assertAllInRange(values); + assertNoDuplicates(values); + } + + @Test + void getNumbersReturnsDefensiveCopy() { + ComputerNumbers numbers = ComputerNumbers.generate(new FixedGenerator(seedNumbers())); + + List first = numbers.getNumbers(); + first.set(0, 9); + + assertThat(numbers.getNumbers()).containsExactly(1, 2, 3); + } + + private void assertAllInRange(List values) { + for (int value : values) { + assertThat(value).isBetween(1, 9); + } + } + + private void assertNoDuplicates(List values) { + boolean[] used = new boolean[10]; + for (int value : values) { + assertThat(used[value]).isFalse(); + used[value] = true; + } + } + + private List seedNumbers() { + List seed = new ArrayList<>(); + seed.add(1); + seed.add(2); + seed.add(3); + return seed; + } + + private static class FixedGenerator extends RandomNumberGenerator { + private final List numbers; + + private FixedGenerator(List numbers) { + this.numbers = numbers; + } + + @Override + public List generate() { + return new ArrayList<>(numbers); + } + } +} diff --git a/src/test/java/camp/nextstep/edu/baseball/domain/GuessNumbersTest.java b/src/test/java/camp/nextstep/edu/baseball/domain/GuessNumbersTest.java new file mode 100644 index 00000000..4509daf8 --- /dev/null +++ b/src/test/java/camp/nextstep/edu/baseball/domain/GuessNumbersTest.java @@ -0,0 +1,64 @@ +package camp.nextstep.edu.baseball.domain; + +import java.util.List; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +class GuessNumbersTest { + + @Test + void fromParsesDigitsToNumbers() { + GuessNumbers guess = GuessNumbers.from("123"); + + List values = guess.getNumbers(); + assertThat(values).containsExactly(1, 2, 3); + } + + @Test + void getNumbersReturnsDefensiveCopy() { + GuessNumbers guess = GuessNumbers.from("123"); + + List first = guess.getNumbers(); + first.set(0, 9); + + assertThat(guess.getNumbers()).containsExactly(1, 2, 3); + } + + @Test + void fromRejectsNull() { + assertInvalidInput(null); + } + + @Test + void fromRejectsEmpty() { + assertInvalidInput(""); + } + + @Test + void fromRejectsWrongLength() { + assertInvalidInput("12"); + } + + @Test + void fromRejectsNonDigit() { + assertInvalidInput("12a"); + } + + @Test + void fromRejectsZero() { + assertInvalidInput("102"); + } + + @Test + void fromRejectsDuplicate() { + assertInvalidInput("112"); + } + + private void assertInvalidInput(String input) { + assertThatThrownBy(() -> GuessNumbers.from(input)) + .isInstanceOf(IllegalArgumentException.class) + .hasMessageStartingWith("[ERROR]"); + } +} diff --git a/src/test/java/camp/nextstep/edu/baseball/domain/RestartValidatorTest.java b/src/test/java/camp/nextstep/edu/baseball/domain/RestartValidatorTest.java new file mode 100644 index 00000000..25780ccf --- /dev/null +++ b/src/test/java/camp/nextstep/edu/baseball/domain/RestartValidatorTest.java @@ -0,0 +1,38 @@ +package camp.nextstep.edu.baseball.domain; + +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThatCode; +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +class RestartValidatorTest { + private final RestartValidator validator = new RestartValidator(); + + @Test + void validateRestartAcceptsOneOrTwo() { + assertThatCode(() -> validator.validateRestart("1")) + .doesNotThrowAnyException(); + assertThatCode(() -> validator.validateRestart("2")) + .doesNotThrowAnyException(); + } + + @Test + void validateRestartRejectsOtherValues() { + assertInvalidRestart("3"); + } + + @Test + void validateRestartRejectsInvalidForms() { + assertInvalidRestart("0"); + assertInvalidRestart("11"); + assertInvalidRestart("a"); + assertInvalidRestart(""); + assertInvalidRestart(null); + } + + private void assertInvalidRestart(String input) { + assertThatThrownBy(() -> validator.validateRestart(input)) + .isInstanceOf(IllegalArgumentException.class) + .hasMessageStartingWith("[ERROR]"); + } +} diff --git a/src/test/java/camp/nextstep/edu/baseball/domain/ResultCalculatorTest.java b/src/test/java/camp/nextstep/edu/baseball/domain/ResultCalculatorTest.java new file mode 100644 index 00000000..23df67f0 --- /dev/null +++ b/src/test/java/camp/nextstep/edu/baseball/domain/ResultCalculatorTest.java @@ -0,0 +1,98 @@ +package camp.nextstep.edu.baseball.domain; + +import camp.nextstep.edu.baseball.util.RandomNumberGenerator; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThat; + +class ResultCalculatorTest { + private final ResultCalculator calculator = new ResultCalculator(); + + @Test + void calculateCountsStrikes() { + Result result = calculator.calculate(answer(4, 2, 5), GuessNumbers.from("123")); + + assertThat(result.getStrikes()).isEqualTo(1); + assertThat(result.getBalls()).isZero(); + } + + @Test + void calculateCountsBalls() { + Result result = calculator.calculate(answer(4, 2, 5), GuessNumbers.from("456")); + + assertThat(result.getStrikes()).isEqualTo(1); + assertThat(result.getBalls()).isEqualTo(1); + } + + @Test + void calculateCountsTwoBalls() { + Result result = calculator.calculate(answer(4, 2, 5), GuessNumbers.from("214")); + + assertThat(result.getStrikes()).isZero(); + assertThat(result.getBalls()).isEqualTo(2); + } + + @Test + void calculateCountsThreeBalls() { + Result result = calculator.calculate(answer(4, 2, 5), GuessNumbers.from("254")); + + assertThat(result.getStrikes()).isZero(); + assertThat(result.getBalls()).isEqualTo(3); + } + + @Test + void calculateCountsTwoStrikes() { + Result result = calculator.calculate(answer(4, 2, 5), GuessNumbers.from("421")); + + assertThat(result.getStrikes()).isEqualTo(2); + assertThat(result.getBalls()).isZero(); + } + + @Test + void calculateCountsOneStrikeTwoBalls() { + Result result = calculator.calculate(answer(4, 2, 5), GuessNumbers.from("452")); + + assertThat(result.getStrikes()).isEqualTo(1); + assertThat(result.getBalls()).isEqualTo(2); + } + + @Test + void calculateReturnsNothing() { + Result result = calculator.calculate(answer(4, 2, 5), GuessNumbers.from("789")); + + assertThat(result.isNothing()).isTrue(); + assertThat(result.getStrikes()).isZero(); + assertThat(result.getBalls()).isZero(); + } + + @Test + void calculateDetectsThreeStrikes() { + Result result = calculator.calculate(answer(7, 1, 3), GuessNumbers.from("713")); + + assertThat(result.isThreeStrikes()).isTrue(); + assertThat(result.getStrikes()).isEqualTo(3); + } + + private ComputerNumbers answer(int first, int second, int third) { + List values = new ArrayList<>(); + values.add(first); + values.add(second); + values.add(third); + return ComputerNumbers.generate(new FixedGenerator(values)); + } + + private static class FixedGenerator extends RandomNumberGenerator { + private final List numbers; + + private FixedGenerator(List numbers) { + this.numbers = numbers; + } + + @Override + public List generate() { + return new ArrayList<>(numbers); + } + } +} diff --git a/src/test/java/camp/nextstep/edu/baseball/util/RandomNumberGeneratorTest.java b/src/test/java/camp/nextstep/edu/baseball/util/RandomNumberGeneratorTest.java new file mode 100644 index 00000000..47e73051 --- /dev/null +++ b/src/test/java/camp/nextstep/edu/baseball/util/RandomNumberGeneratorTest.java @@ -0,0 +1,34 @@ +package camp.nextstep.edu.baseball.util; + +import java.util.List; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThat; + +class RandomNumberGeneratorTest { + + @Test + void generateReturnsThreeDistinctNumbersInRange() { + RandomNumberGenerator generator = new RandomNumberGenerator(); + + List values = generator.generate(); + + assertThat(values).hasSize(3); + assertAllInRange(values); + assertNoDuplicates(values); + } + + private void assertAllInRange(List values) { + for (int value : values) { + assertThat(value).isBetween(1, 9); + } + } + + private void assertNoDuplicates(List values) { + boolean[] used = new boolean[10]; + for (int value : values) { + assertThat(used[value]).isFalse(); + used[value] = true; + } + } +}