[AOS] Android Studio Wildcard (*) Import 설정

 

 

🤖

Wildcard import (cannot be auto-corrected)❗️

🤖

Wildcard import (cannot be auto-corrected)❗❗️

🤖

Wildcard import (cannot be auto-corrected)❗❗❗️

💢💢💢💢

🐶

 

 

 

 

 

 

Wildcard Import

wildcard import란 동일한 패키지에서 여러 class를 import해 사용하게 되는 경우 편의를 위해 wildcard 문자를 사용해 명시하는 것을 말한다.

 

예를 들어 아래와 같이 여러 줄의 import문을 한 줄로 간단하게 명시할 수 있도록 하는 기능을 말한다.

 

import java.util.list
import java.util.arrays
import java.util.arraylist

👇🏻

import java.util.*

 

 

ktlint를 사용하면 wildcard import를 사용하지 못하게 한다.

wildcard import가 코드 간 혼란을 유발하기 때문인데, wildcard import를 사용하는 데에 단점만이 있는 것은 아니다.

아래는 wildcard import를 사용했을 때의 장단점이다.

 

장점

1. Clean Code
    wildcard import를 사용하면 긴 import 목록을 줄여 가독성을 높일 수 있다.

 

2. 리팩토링 용이성
    클래스 이름 변경 시, 특정 import 선언을 변경할 필요가 없다.
    또한 클래스의 패키지 변경 시 wildcard import를 사용한 경우, 코드를 리팩토링 할 필요가 없다.

 

3. 코드 결합성(coupling) 완화
    wildcard import는 코드 간 결합성 완화를 강제한다.
    패키지 내에 특정 클래스가 존재하지 않아도 되기 때문에 결합성이 완화된다.

 

단점

1. 클래스 이름 충돌
    wildcard를 통해 가져온 패키지에서 둘 이상의 클래스 이름이 발견되는 경우, 또는 패키지가 업데이트 되면서 클래스가 변경되었을 때 충돌이 발생할 수 있다.

 

2. 명확성 저하
    각각 사용한 패키지의 함수를 명시해 import한 경우보다 명확하게 인지하기 어렵다.

 

 

Android Studio에서는 자동 설정으로 5개 이상의 동일한 패키지 import를 사용하면 wildcard import로 변경해준다.

ktlint를 사용한다면 편의를 위해 아래와 같이 wildcard import 설정을 해제해 주는 것이 편리하다.

 

 

 

Wildcard Import 설정하기

* Mac OS 기준

 

1. Android Studio > Preferences...

 

 

2. Editor > Code Style > kotlin (or Java)

 

현재 프로젝트에서 사용하는 언어 (Kotlin 또는 Java)를 선택해준다.

Kotlin에서만 설정을 했으면 Java를 사용할 땐 적용이 되지 않고, Java에서만 설정을 했으면 Kotlin을 사용할 땐 적용되지 않는다.

 

 

3. 내부 메뉴에서 Imports 선택

 

 

4. Use import with '*' when at least 5 names used -> Use single name import로 변경 후 Apply