1모든 식별자에 공통으로 적용되는 규칙
식별자에는 ASCII 문자와 숫자만 쓰고, 아래에 명시된 몇몇 경우에만 밑줄을 쓴다. 따라서 유효한 식별자 이름은 모두 정규식 \w+에 매치된다.
구글 스타일에서는 특별한 접두사나 접미사를 쓰지 않는다. 예를 들어 다음 이름들은 구글 스타일이 아니다.
name_mNames_namekName
1모든 식별자에 공통으로 적용되는 규칙
식별자에는 ASCII 문자와 숫자만 쓰고, 아래에 명시된 몇몇 경우에만 밑줄을 쓴다. 따라서 유효한 식별자 이름은 모두 정규식 \w+에 매치된다.
구글 스타일에서는 특별한 접두사나 접미사를 쓰지 않는다. 예를 들어 다음 이름들은 구글 스타일이 아니다.
name_mNames_namekName2클래스 이름
클래스 이름은 **UpperCamelCase**로 쓴다.
클래스 이름은 보통 명사 또는 명사구다. 예를 들어 Character, ImmutableList. 인터페이스 이름도 명사나 명사구일 수 있지만(예: List), 때로는 형용사나 형용사구가 되기도 한다(예: Readable).
애너테이션 타입의 네이밍에는 특별한 규칙도, 널리 자리 잡은 관례도 없다.
테스트 클래스는 이름이 Test로 끝난다. 예: HashIntegrationTest.
단일 클래스를 다루는 테스트라면, 그 클래스 이름에 Test를 붙인 이름을 쓴다. 예: HashImplTest.
3메서드 이름
메서드 이름은 **lowerCamelCase**로 쓴다.
메서드 이름은 보통 동사 또는 동사구다. 예를 들어 sendMessage, stop.
JUnit 테스트 메서드 이름에서는 이름의 논리적 구성 요소를 구분하기 위해 밑줄을 쓸 수 있고, 각 구성 요소는 lowerCamelCase로 쓴다.
1void transferMoney_deductsFromSource() { ... }
테스트 메서드 이름을 짓는 "유일하게 올바른 방법"은 없다.
이 함수가 하는 일
CharSequence 하나를 받아 true/false를 돌려줍니다. 공백이 아닌 글자가 하나라도 있으면 true입니다.
true: "a", " a ", " . "false: null, "", " "1@Contract("null -> false")
2public static boolean (@Nullable CharSequence str) {
3 if (str == null) {
4 return false;
5 }
6
7 int strLen = str.length();
8 if (strLen == 0) {
9 return false;
10 }
11
12 for (int i = 0; i < strLen; i++) {
13 if (!Character.isWhitespace(str.charAt(i))) {
14 return true;
15 }
16 }
17 return false;
18}
이 함수가 하는 일
CharSequence를 받아 공백 문자를 전부 없앤 결과를 돌려줍니다. 앞뒤뿐 아니라 가운데 공백까지 없앱니다.
" a b c " → "abc"null이면 받은 것을 그대로 돌려줍니다1public static CharSequence (CharSequence str) {
2 if (!hasLength(str)) {
3 return str;
4 }
5
6 int len = str.length();
7 StringBuilder sb = new StringBuilder(str.length());
8 for (int i = 0; i < len; i++) {
9 char c = str.charAt(i);
10 if (!Character.isWhitespace(c)) {
11 sb.append(c);
12 }
13 }
14 return sb;
15}
이 함수가 하는 일
문자열, 최소 길이, 채울 문자 하나를 받습니다. 문자열이 최소 길이보다 짧으면 앞쪽에 그 문자를 반복해 붙여 길이를 맞춥니다. 이미 길면 받은 문자열을 그대로 돌려줍니다.
("7", 3, '0') → "007"("2010", 3, '0') → "2010"1public static String (String string, int minLength, char padChar) {
2 checkNotNull(string);
3 if (string.length() >= minLength) {
4 return string;
5 }
6 StringBuilder sb = new StringBuilder(minLength);
7 for (int i = string.length(); i < minLength; i++) {
8 sb.append(padChar);
9 }
10 sb.append(string);
11 return sb.toString();
12}
4상수 이름
상수 이름은 **UPPER_SNAKE_CASE**를 쓴다. 전부 대문자이고, 각 단어는 밑줄 하나로 구분한다. 그런데 상수란 정확히 무엇인가?
상수는 static final 필드로서, 그 내용이 깊이(deeply) 불변이고 그 메서드에 관측 가능한 부수 효과가 없는 것이다. 원시 타입, 문자열, 불변 값 클래스, 그리고 null로 설정된 모든 것이 그 예다.
인스턴스의 관측 가능한 상태가 바뀔 수 있다면 상수가 아니다. 단지 절대 변경하지 않겠다는 의도만으로는 충분하지 않다.
1// 상수
2static final int NUMBER = 5;
3static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann");
4static final Map<String, Integer> AGES = ImmutableMap.of("Ed", 35, "Ann", 32);
5static final Joiner COMMA_JOINER = Joiner.on(','); // Joiner 가 불변이므로
6static final SomeMutableType[] EMPTY_ARRAY = {};
7
8// 상수가 아닌 것
9static String nonFinal = "non-final";
10final String nonStatic = "non-static";
11static final Set<String> mutableCollection = new HashSet<String>();
12static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable);
13static final ImmutableMap<String, SomeMutableType> mutableValues =
14 ImmutableMap.of("Ed", mutableInstance, "Ann", mutableInstance2);
15static final Logger logger = Logger.getLogger(MyClass.getName());
16static final String[] nonEmptyArray = {"these", "can", "change"};
이 이름들은 보통 명사 또는 명사구다.
5상수가 아닌 필드 이름
상수가 아닌 필드 이름은(static이든 아니든) **lowerCamelCase**로 쓴다.
이 이름들은 보통 명사 또는 명사구다. 예를 들어 computedValues, index.
6매개변수 이름
매개변수 이름은 **lowerCamelCase**로 쓴다.
public 메서드에서 한 글자 매개변수 이름은 피해야 한다.
7지역 변수 이름
지역 변수 이름은 **lowerCamelCase**로 쓴다.
final이고 불변이라 해도 지역 변수는 상수로 간주하지 않으며, 상수 스타일로 쓰지 않는다.
이 함수가 하는 일
trimLeadingCharacter 안의 지역 변수입니다. 0에서 시작해 앞쪽의 지정된 문자를 건너뛰며 하나씩 올라가고, 마지막에 substring의 시작 위치로 쓰입니다.
1public static String trimLeadingCharacter(String str, char leadingCharacter) {
2 if (!hasLength(str)) {
3 return str;
4 }
5
6 int = 0;
7 while ( < str.length() && leadingCharacter == str.charAt()) {
8 ++;
9 }
10 return str.substring();
11}
이 함수가 하는 일
trimTrailingCharacter 안의 지역 변수입니다. 문자열 맨 끝에서 시작해 뒤쪽의 지정된 문자를 건너뛰며 하나씩 내려가고, 마지막에 substring의 끝 위치로 쓰입니다.
1public static String trimTrailingCharacter(String str, char trailingCharacter) {
2 if (!hasLength(str)) {
3 return str;
4 }
5
6 int = str.length() - 1;
7 while ( >= 0 && trailingCharacter == str.charAt()) {
8 --;
9 }
10 return str.substring(0, + 1);
11}
8타입 변수 이름
타입 변수는 다음 두 스타일 중 하나로 이름 짓는다.
E, T, X, T2T를 붙인다. 예: RequestT, FooBarT9이름 없는 변수
이름 없는 변수와 매개변수를 위한 _ 문법은 적용 가능한 곳이라면 어디서든 허용된다.
1Predicate<String> alwaysTrue = _ -> true;
10카멜 케이스의 정의
영어 구절을 카멜 케이스로 바꾸는 합리적인 방법이 둘 이상인 경우가 있다. "IPv6"나 "iOS" 같은 약어나 특이한 표기가 섞여 있을 때가 그렇다. 예측 가능성을 높이기 위해 구글 스타일은 다음의 (거의) 결정론적인 절차를 규정한다.
이름의 산문 형태에서 시작한다.
2단계에는 권장 사항이 하나 붙는다. 어떤 단어가 통상적인 용법에서 이미 카멜 케이스 모양이라면 그것을 구성 요소로 쪼갠다("AdWords"는 "ad words"가 된다). 단 "iOS" 같은 단어는 엄밀히 말해 카멜 케이스가 아니다. 어떤 관례도 따르지 않으므로 이 권장 사항이 적용되지 않는다.
원래 단어의 대소문자는 거의 전적으로 무시된다는 점에 유의한다.
아주 드문 경우(예: 여러 부분으로 된 버전 번호)에는 인접한 숫자를 구분하기 위해 밑줄을 써야 할 수도 있다. 숫자에는 대문자·소문자 구분이 없기 때문이다.
| 산문 형태 | 올바름 | 틀림 |
|---|---|---|
| "XML HTTP request" | XmlHttpRequest | XMLHTTPRequest |
| "new customer ID" | newCustomerId | newCustomerID |
| "inner stopwatch" | innerStopwatch | innerStopWatch |
| "supports IPv6 on iOS?" | supportsIpv6OnIos | supportsIPv6OnIOS |
| "YouTube importer" | YouTubeImporter | — |
| "Turn on 2SV" | turnOn2sv | turnOn2Sv |
| "Guava 33.4.6" | guava33_4_6 | guava3346 |
"YouTube importer"는 YoutubeImporter도 허용되지만 권장하지는 않는다.
참고: 영어에서 하이픈 사용이 모호한 단어들이 있다. 예를 들어 "nonempty"와 "non-empty"는 둘 다 맞으므로, 메서드 이름
checkNonempty와checkNonEmpty역시 둘 다 맞다.