Code conventions check
#01 Android Java code style
Code conventions check
새로운 프로젝트를 시작하기에 앞서, 여러 명이 협업하기 위해 Code conventions을 맞출 필요가 있습니다. 그리고 이를 확인하고 검사하는 과정도 필요한데, 직접 사람이 눈으로 확인하기에는 공수가 많이 들어갑니다.
제가 이용하는 Code convetions, 그리고 이를 손쉽게 확인해주는 도구들과 직접 안드로이드 스튜디오에 연동하는 방법을 알아보겠습니다.
Android Java code style
먼저 Code conventions을 정해야 합니다.
프로젝트마다 고유의 코드 스타일이 있을 수 도 있지만, 없다면 안드로이드에서 기본으로 제공하는 코드 스타일을 그대로 이용하는 게 좋습니다.
아래는 기본 코드 스타일을 기반으로 조금 수정한 내용입니다. 참고만 해주시기 바랍니다.
1. Java language rules
1.1 Don't ignore exceptions
절대 해서는 안됩니다!
void setServerPort(String value) {
try {
serverPort = Integer.parseInt(value);
} catch (NumberFormatException e) { }
}
Exception이 발생하지 않거나, 굳이 처리하지 않아도 괜찮다고 생각할 수 있지만, 이 exception 들을 무시하면 언젠가는 큰 문제가 일어날 수 도 있습니다. 코드에서 모든 exception들을 원칙적으로 처리해야 합니다. 구체적인 처리 방법은 경우에 따라 다를 수 있습니다. - (Android code style guidelines)
1.2 Don't catch generic exception
절대 해서는 안됩니다!
try {
someComplicatedIOFunction(); // may throw IOException someComplicatedParsingFunction(); // may throw ParsingException someComplicatedSecurityFunction(); // may throw SecurityException
// phew, made it all the way
} catch (Exception e) {
// I'll just catch all exceptions handleError();
// with one generic handler!
}
1.3 Don't use finalizers
절대 finalizers를 이용해서는 안됩니다!
1.4 Fully qualify imports
Bad: import foo.*;
Good: import foo.Bar;
2. Java style rules
2.1 Fields definition and naming
소문자로 시작해야 합니다.
public class MyClass {
public static final int SOME_CONSTANT = 42;
private static MyClass singleton;
int packagePrivate;
private int private;
protected int protected;
public int publicField;
}
2.2 Method, Class and Interface naming
메서드(Method) 이름은 소문자로 시작해야 합니다.
public class MyClass {
public int getAge() {
return 0;
}
}
클래스(Class)와 인터페이스(Interface) 이름은 대문자로 시작해야 합니다.
public class MyClass {}
public interface MyInterface {}
수식자(modifiers)의 순서를 지켜야 합니다.
1. public
2. protected
3. private
4. abstract
5. default
6. static
7. final
8. transient
9. volatile
10. synchronized
11. native
12. strictfp
public static final int TEMP_VALUE = 0; // Good
static public final int TEMP_VALUE = 0; // Bad
final public static int TEMP_VALUE = 0; // Bad
2.3 Treat acronyms as words
XmlHttpRequest // Good
XMLHTTPRequest // Bad
getCustomerId // Good
getCustomerID // Bad
String url // Good
String URL // Bad
long id // Good
long ID // Bad
2.4 Use spaces for indentation
User 1 space indent after comma [,], semi [;], type cast[(String) str]
getData(Context context, String id, int type); // comma [,]
for(int i = 0; i < 10; i++) { // semi [;]
View view = (View) findByViewId(R.id.view); // type cast[(String) str]
Use 4 space indents for blocks:
if (x == 1) {
x++;
}
Use 8 space indents for line wraps:
Instrument i =
someLongExpression(that, wouldNotFit, on, one, line);
반대로 공백(space)을 허용하지 않는 부분도 있습니다.
No whitespace before semi [;], dot [.], post_dec [--], post_inc [++].
getData(Context context, String id, int type) ; // 허용 안됨 semi [;] pager. setAdapter(adapter); // 허용 안됨 dot [.]
sum --; // 허용 안됨 post_dec [--]
count ++; // 허용 안됨 post_inc [++]
No whitespace after dec [--], inc [++], dot [.], lnot [!].
-- sum; // 허용 안됨 dec [--]
++ count; // 허용 안됨 inc [++]
pager. setAdapter(adapter); // 허용 안됨 dot [.]
! isFinish; // 허용 안됨 lnot [!]
2.5 Use standard line rule
한 줄(line)에 하나의 문장만 있어야 합니다.
int var1; int var2; // 허용 안됨
var1 = 1; var2 = 2; // 허용 안됨
int var1 = 1; int var2 = 2; // 허용 안됨
var1++; var2++; // 허용 안됨
Object obj1 = new Object(); Object obj2 = new Object(); // 허용 안됨
import java.io.EOFException; import java.io.BufferedReader; // 허용 안됨
;; // 허용 안됨
nt var1 = 1; var2 = 2; // 허용 안됨
int o = 1, p = 2,r = 5; int t; // 허용 안됨
dot [.]을 기준으로 줄 바꿈을 합니다.
builder
.appModule(new Module()) // Good
.errorModule(new ErrorModule())
.build();
builder.
appModule(new Module()). // Bad
errorModule(new ErrorModule()).
build();
comma [,]을 기준으로 줄 바꿈을 합니다.
public int getValue(int first, // Good
int second,
int third) {
public int getValue(int first // Bad
,int second
,int third) {
package, all import declarations, class 사이에 빈 한 줄(Empty line)이 있어야 합니다.
package com.puppycrawl.tools.checkstyle.whitespace;
// empty line
import java.io.Serializable;
// empty line
class Foo {
public static final int FOO_CONST = 1;
public void foo() {}
}
2.6 Use standard brace style
중괄호 {}는 앞에 있는 코드와 같은 줄에 있어야 합니다.
class MyClass {
int func() {
if (something) {
//...
} else if (somethingElse) {
//...
} else {
//...
}
}
}
만약 조건 if-else와 본문(statements)이 한 줄에 있다면 중괄호가 없어도 괜찮습니다.
if (condition) body(); // Good
if (condition)
body(); // bad!
2.7 Annotations
클래스, 메서드, 생성자에서는 한 라인별로 annotation을 선언해야 합니다.
/* This is the documentation block about the class*/
@AnnotationA
@AnnotationB
public class MyAnnotatedClass { }
필드에서는 한 라인에 annotation을 모두 선언해야 합니다.
@Nullable @Mock DataManager mDataManager;
2.8 Limit variable scope
지역 변수의 범위는 최소한으로 유지되어야 합니다 (Effective Java Item 29). 그렇게 함으로써 코드의 가독성과 유지 보수성을 높이고 오류의 가능성을 줄일 수 있습니다. 각 변수는 변수의 모든 용도를 둘러싸는 가장 안쪽의 블록에서 선언되어야 합니다.
지역 변수는 처음 사용된 시점에서 선언해야 합니다. 거의 모든 지역 변수 선언에는 초기화(initializer)가 있어야 합니다. 변수를 현명하게 초기화하는 데 필요한 정보가 아직 충분하지 않은 경우에는 선언을 연기해야 합니다.- (Android code style guidelines)
2.9 Logging guidelines
Log 클래스가 제공하는 로깅 메서드를 이용하여 오류 메시지나 기타 정보들을 출력합니다.
Log.v(String tag, String msg) (verbose)
Log.d(String tag, String msg) (debug)
Log.i(String tag, String msg) (information)
Log.w(String tag, String msg) (warning)
Log.e(String tag, String msg) (error)
일반적으로 클래스 이름을 TAG로 이용하고 이를 파일의 맨 위에 static final필드로 정의합니다.
public class MyClass {
private static final String TAG = "MyClass";
public myMethod() {
Log.e(TAG, "My error message");
}
}
Release 빌드에서는 VERBOSE 및 DEBUG 로그를 반드시 비활성화해야 합니다. 또한 INFORMATION, WARNING 및 ERROR 로그도 비활성화하는 것이 좋지만 릴리스 빌드에서 문제를 식별하는 것이 유용할 수 있다고 생각되는 경우 이를 활성화하는 것이 좋습니다. 활성화한 경우 이메일 주소, 사용자 ID 등과 같은 개인 정보가 유출되지 않도록 주의해야 합니다.
if (BuildConfig.DEBUG) Log.d(TAG, "The value of x is " + x);
2.10 Class member ordering
정답이 없는 부분이긴 하지만 logical 및 consistent 순서를 따르면 가독성이 더 좋아집니다.
1. Constants
2. Fields
3. Constructors
4. Override methods and callbacks (public or private)
5. Public methods
6. Private methods
7. Inner classes or interfaces
public class MainActivity extends Activity {
private String title;
private TextView textViewTitle;
public void setTitle(String title) {
this.title = title;
}
@Override
public void onCreate() {
...
}
private void setUpView() {
...
}
static class AnInnerClass {
}
}
Activity나 Fragment 같은 안드로이드 구성 요소는 생명주기(lifecycle)를 나열하는 게 가독성이 더 좋습니다. 예를 들어, Activity는 아래와 같이 구현할 수 있습니다.
public class MainActivity extends Activity {
//Order matches Activity lifecycle
@Override public void onCreate() {}
@Override public void onResume() {}
@Override public void onPause() {}
@Override public void onDestroy() {}
}
Overload methods 들은 함께 그룹화되어 있어야 합니다.
public void foo(int i) {}
public void foo(String s) {}
public void notFoo() {} // Have to be after foo(int i, String s)
public void foo(int i, String s) {}
2.11 Parameter ordering in methods
안드로이드 프로그래밍을 할 때 Context을 취하는 메서드를 정의하는 경우는 빈번하게 발생합니다. 이와 같은 메서드를 작성하는 경우 Context는 첫 번째 매개 변수(parameter) 여야 합니다.
반대로 callback interface는 마지막 매개 변수(parameter) 여야 합니다.
// Context always goes first
public User loadUser(Context context, int userId);
// Callbacks always go last
public void loadUserAsync(Context context, int userId, UserCallback callback);
2.12 String constants, naming, and values
SharedPreferences, Bundle, Intent와 같은 안드로이드 SDK의 많은 요소들은 키-값 쌍 접근법을 이용하기 때문에 많은 문자열 상수를 작성해야 할 가능성이 높습니다.
이 컴포넌트들 중 하나를 사용할 때 키를 반드시 static final 필드로 정의하십시오. 아래에 표시된 것처럼 접두사를 사용해야 합니다.
Element : Field Name Prefix
SharedPreferences : PREF_
Bundle : BUNDLE_
Fragment Arguments : ARGUMENT_
Intent Extra : EXTRA_
Intent Action : ACTION_
Fragment.getArguments ()의 인수 또한 Bundle이지만 이 Bundle은 매우 일반적인 용도이므로 다른 접두사(BUNDLE_)를 정의합니다.
// Note the value of the field is the same as the name to avoid duplication issues
static final String PREF_EMAIL = "PREF_EMAIL";
static final String BUNDLE_AGE = "BUNDLE_AGE";
static final String ARGUMENT_USER_ID = "ARGUMENT_USER_ID";
// Intent-related items use full package name as value
static final String EXTRA_SURNAME = "com.myapp.extras.EXTRA_SURNAME";
static final String ACTION_OPEN_USER = "com.myapp.action.ACTION_OPEN_USER";
public static Intent getStartIntent(Context context, User user) {
Intent intent = new Intent(context, ThisActivity.class); intent.putParcelableExtra(EXTRA_USER, user);
return intent;
}
public static UserFragment newInstance(User user) {
UserFragment fragment = new UserFragment;
Bundle args = new Bundle();
args.putParcelable(ARGUMENT_USER, user);
fragment.setArguments(args)
return fragment;
}
2.13 Line length limit
코드 라인은 100자 를 초과하지 않아야 합니다. 만약 이 제한보다 길면 길이를 줄이기 위해 일반적으로 두 가지 옵션이 있습니다.
로컬 변수 또는 메서드를 추출합니다 (권장).
줄 바꿈을 적용하여 한 줄을 여러 줄로 나눕니다.
100자 보다 긴 코드 라인을 가질 수 있는 두 가지 exceptions 이 있습니다.
분할할 수 없는 라인 (ex: 긴 URL)
package와 import 문.
3. XML style rules
3.1 Use self closing tags
XML 요소에 내용이 없으면 반드시 self closing 태그를 사용하십시오.
<TextView
android:id="@+id/text_view_profile"
android:layout_width="wrap_content"
android:layout_height="wrap_content" />
<!-- Don't do this! -->
<TextView
android:id="@+id/text_view_profile"
android:layout_width="wrap_content"
android:layout_height="wrap_content" >
</TextView>
3.2 Resources naming
3.2.1 ID naming
ID 앞에는 소문자로 된 밑줄의 요소 이름이 접두사로 붙어야 합니다.
Element : Prefix
TextView : text_
ImageView : image_
Button : button_
Menu : menu_
<ImageView
android:id="@+id/image_profile"
android:layout_width="wrap_content"
android:layout_height="wrap_content" />
<menu>
<item
android:id="@+id/menu_done"
android:title="Done" />
</menu>
3.2.2 Strings
문자열 이름은 자신이 속한 섹션을 식별하는 접두사로 시작합니다.
ex) registration_email_hint or registration_name_hint. 문자열이 어떤 섹션에도 속하지 않으면 다음 규칙을 따라야 합니다.
Prefix : Description
error_ : An error message
msg_ : A regular information message
title_ : A title, i.e. a dialog title
action_ : An action such as "Save" or "Create"
3.2.3 Styles and Themes
나머지 리소스가 없으면 UpperCamelCase로 이름이 작성해야 합니다.
자세한 내용은 아래 Git.wiki에서 확인할 수 있습니다.
https://github.com/oemilk/ilovepooq/wiki/2.-Code-guidelines
이 글은 아래 링크 내용들을 기반으로 작성했습니다.
위에 작성한 안드로이드 자바 코드 스타일을 기반으로 실제 확인하고 검사하는 도구는 다음 글에 작성하겠습니다.
