Skip to content

Latest commit

 

History

History
185 lines (163 loc) · 7 KB

Java.md

File metadata and controls

185 lines (163 loc) · 7 KB

Java

아래 정의되어 있는 가이드외에는 Google Java Style Guide를 따른다.

Parameter/Argument

Parameter 순서

  • Context류의 parameter를 가장 앞에 위치한다. (Context, Activity, Fragment, View등)
  • Callback류의 parameter를 가장 뒤에 위치한다. (XXXListener, XXXCallback, XXXSubject등)
public Car getCar(Context context, int hashId);
public void loadCar(Context context, int hashId, CarListener listener);

Key

  • Key-Value로 활용되는 컴포넌트들의 Key는 static final String KEY_XXX로 정의한다.
  • Key로 정의된 이름의 String값은 동일하게 맞춰준다.
  • Deeplink에서 사용되는 Query Parameter의 경우 aaa://bb?key1=value1&key2=value2와 같은 방식으로 전달되기때문에 query key와 맞춰준다.
public static final String KEY_HASH_ID = "KEY_HASH_ID";
public static final String KEY_TRADE = "KEY_TRADE";
public static final String QUERY_REFERRER = "referrer"; // deeplink

Key with Activity/Fragment

Activity

  • Activity Intent에 KEY_를 넣어주는 경우, 해당 Activity에 startActivity() 혹은 getIntent()를 구현하고 이를 사용한다.
public static void startActivity(Context context, @DrawableRes int photoResourceId) {  
  Intent intent = new Intent(context, PhotoDetailActivity.class);  
  intent.putExtra(KEY_PHOTO_RESOURCE_ID, photoResourceId);  
  context.startActivity(intent);  
}
public static Intent getIntent(Context context, String brandId, String brandName) {  
  Intent intent = new Intent(context, SelectCarActivity.class);  
  intent.putExtra(KEY_BRAND_ID, brandId);  
  intent.putExtra(KEY_BRAND_NAME, brandName);  
  return intent;  
}

Fragment

public static UserFragment newInstance(User user) {
	UserFragment fragment = new UserFragment();
	Bundle args = new Bundle();
	args.putParcelable(KEY_USER, user);
	fragment.setArguments(args)
	return fragment;
}

기타

  • startActivity() / getIntent() / newInstance()에서 쓰이는 Key는 항상 private static final로 만든다.

Lambda Parameter

  • 사용되지 않는 Parameter의 이름은 __를 사용한다. : 무시해야 하는 Parameter가 여러개라면 __, ___, ____ 등으로 정의한다.
binding.viewContainer.setOnClickListener(__ -> startRegisterActivity());
binding.tvConfirm.setOnClickListener(__ -> dismiss());

Line

  • 1줄에 100자를 넘지 않도록 작성한다.
  • 코드간의 간격은 2줄이상 간격이 발생하지 않도록 한다.(최대 1줄 줄바꿈)

Parameter

  • Parameter개수가 많아서 줄바꿈이 필요한 경우, ,다음부터 줄바꿈한다.
public InputSingleTextView(Context context,  
  @RegisterStep String step,  
  String hint,  
  String validationMessage,  
  @NonNull CompleteListener completeListener) {  
  ...
}
  • 줄바꿈이 필요한 부분부터 줄바꿈 하지 않고 위의 예시처럼 1개 단위로 줄바꿈을 해준다.
  • 이런 함수를 호출하는 코드에서도 같은 패턴으로 맞춰서 호출한다.
new InputSingleTextView(this,
   RegisterStep.XXX,
   getString(R.string.xxx),
   getString(R.string.xxx),
   completeListener);

Operator

  • 많은 operator의 연산으로 줄바꿈이 필요한 경우, operator 전에 줄바꿈한다.
int longName = anotherVeryLongVariable + anEvenLongerOne - thisRidiculousLongOne
        + theFinalOne;
  • 연산자의 경우는 줄바꿈이 필요한 위치부터 줄바꿈한다.

Method chain

  • Builder/RxJava 등 여러 함수를 chaining으로 사용하면서 줄바꿈이 필요한 경우, .전에 줄바꿈한다.
ImageLoader.load(user.getProfileUrl())  
        .placeholder(R.drawable.img_user_placeholder)  
        .fitCenter()  
        .into(binding.ivUser);

새파일 생성시 주석

  • 새로운 파일을 만들때 자동으로 만들어지는 주석은 만들지 않는다.
  • 예)
/**
 * Created by ted on 2018-07-12.
 */
  • 수정방법: Preferences -> Editor -> File and Code Templates -> includes탭 -> File Header 내용 삭제

Annotation

  • 외부에서 호출할 수 있는 public 함수에서는 항상 @NonNull / @Nullable 어노테이션을 추가해준다.
    public RegisterStepManager(@NonNull RegisterContract.View view,
                               @NonNull Activity activity,
                               @NonNull RegisterContract.Presenter presenter,
                               @NonNull ActivityRegisterBinding binding,
                               @NonNull String registerHashId) {
        this.view = view;
        this.activity = activity;
        this.presenter = presenter;
        this.binding = binding;
        this.registerHashId.set(registerHashId);
        binding.setIsLoading(isLoading);
        setMessageRecyclerView();
        setListener();
    }

Util/Helper/Manager

  • 특정기능을 수행하거나 상태를 관리하거나 분리되어 동작을 수행하는 클래스에 대한 사용처별 이름을 정의한다.

Util

  • public static void AAA등으로 쓰이는 여러곳에서 사용되는 util성 기능을 보아둔 클래스
  • aa.bb.cc.util 패키지에 모두 모아둔다.
  • 예) DateFormatUtil, PixelUtil, BitmapUtil등

Helper

  • 특정 패키지나 기능에서 한정되어 사용되는 public static void AAA 클래스
  • 공통으로 쓰이지 않고 특정 기능의 코드를 분리하기 위한 용도로 사용한다.
  • 예) NotificationChannelHelper등

Manager

  • 항상 내부에서 instance로 만들어서 관리되는 용도
  • 내부적으로 state 혹은 information을 가지고 있어서 호출한곳에서의 상태에 따라서 관리되는 값을 변경하고 반영하는 작업을 해준다.
  • 예) RegisterStepManager, RegisterCarInfoConfirmManager등

if문

  • if (isChecked == false) 와 같은 코드는 명백한 Lint warning이므로 사용하지 않는다.
if (isUnchekced)
  • 조건문에 !를 넣는것대신 아래와 같은 규칙으로 코드를 작성한다.
  1. 조건문에서 체크되는 boolean 변수/함수는 항상 긍정문으로 작성한다. if(isChecked())
  2. 이미 부정문으로 작성되어 있는 함수가 있다면 이를 재사용하여 함수를 작성한다. if(isUnchekced())
private boolean isUnchekced(){
        return !isChecked();
}

기타

  • import static xx.xx.xx;는 사용하지 않는다. (Avoid static imports)
  • try/catch를 사용한경우, Exception에 대한 처리를 항상 넣어준다.
} catch (Exception e) {
    AnalyticsUtil.logException(e);
}