[Android] FragmentFactory

💡FragmentFactory에 대하여 학습한 내용을 기록하였습니다.

 

FragmentFactory

• Android에서 Fragment 인스턴스를 생성하는 방식을 커스터마이징할 수 있는 클래스입니다.
• 기본적으로 Android Fragment를 파라미터 없는 기본 생성자로 생성하지만, 경우에 따라 Fragment를 생성할 때 의존성이나 파라미터를 주입해야 할 때가 있습니다.
• FragmentFactory를 사용하여 Fragment의 생성 방식을 변경할 수 있습니다.
• ViewModel 또는 Repository와 같은 의존성을 Fragment에 주입해야 할 때 FragmentFactory를 사용하여 생성자에 필요한 의존성을 주입할 수 있습니다.

Fragment 생성자

• 아래와 같이 파라미터를 전달받는 Fragment를 제작할 경우 예외가 발생할 수 있습니다.

class MainFragment constructor(
    private val tag: String,
): Fragment()

RuntimeException

• Fragment 생성자를 찾지 못한다는 런타임 에러가 발생합니다.

java.lang.InstantiationException: Unable to instantiate fragment

• 공식문서에서는 Fragment는 인자가 하나도 존재하지 않는 기본 생성자를 필수로 포함되어야한다고 명시되어 있습니다.

Fragment  |  Android Developers

Fragment  |  Android Developers

All subclasses of Fragment must include a public no-argument constructor. The framework will often re-instantiate a fragment class when needed, in particular during state restore, and needs to be able to find this constructor to instantiate it. If the no-argument constructor is not available, a runtime exception will occur in some cases during state restore.

발생 이유는 무엇일까?

• Fragment는 생명주기에 따라서 안드로이드 내부에서 파괴와 생성을 반복합니다.
  • 화면 회전, 백그라운드 상태와도 관련이 있습니다.
• 복원 과정에서 FragmentManager에 의해서 Fragment를 복원하거나 Bundle을 통해 상태를 복원할 때 기본 생성자를 사용합니다.
• 이 때 파괴 후 재생성되는 단계에서 빈 생성자를 호출하며, 빈 생성자를 찾지 못하게 되어 문제가 발생합니다.

Instantiate

public static Fragment instantiate(@NonNull Context context, @NonNull String fname,
            @Nullable Bundle args) {
        try {
            Class<? extends Fragment> clazz = FragmentFactory.loadFragmentClass(
                    context.getClassLoader(), fname);
            Fragment f = clazz.getConstructor().newInstance();
            if (args != null) {
                args.setClassLoader(f.getClass().getClassLoader());
                f.setArguments(args);
            }
            return f;
        } 
        ...
    }

• FragmnetFactory.loadFragmentClass()는 getConstructor()로 생성자를 가져와 newInstance()로 객체를 생성합니다.
• 생성 된 Fragment 인스턴스에 전달할 Argument를 설명하고 인스턴스를 리턴합니다.
• 이 때 getConstructor() 과정에서 기본 생성자가 없으면 예외를 던집니다.

FragmentFactory를 활용한 의존성 주입

• 의존성 주입이나 파라미터가 필요한 경우 FragmentFactory를 사용하여 Fragment를 생성할 수 있습니다.
• 이 방법을 통해서 Fragment의 기본 생성자가 없더라도 커스텀 팩토리를 통해 생성 과정을 제어할 수 있습니다.

class MyFragment(private val myDependency: MyDependency) : Fragment() {
    // Fragment logic
}

class MyFragmentFactory(private val myDependency: MyDependency) : FragmentFactory() {
    override fun instantiate(classLoader: ClassLoader, className: String): Fragment {
        return when (className) {
            MyFragment::class.java.name -> MyFragment(myDependency)
            else -> super.instantiate(classLoader, className)
        }
    }
}

• 기본 생성자를 제공하지 않더라도 FragmentFactory를 통해 의존성 주입이 가능합니다.

Activity에서 FragmentFactory 생성

• 액티비티에서 FragmentFactory를 설정하여 FragmentManager가 Fragment를 생성할 때 커스텀 팩토리를 사용하도록 합니다.

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        // FragmentFactory를 설정
        val myDependency = MyDependency()
        supportFragmentManager.fragmentFactory = MyFragmentFactory(myDependency)

        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // Fragment 추가
        if (savedInstanceState == null) {
            supportFragmentManager.beginTransaction()
                .replace(R.id.fragment_container, MyFragment::class.java, null)
                .commitNow()
        }
    }
}

정리

• 기본 생성자가 없는 Fragment를 생성하면 안드로이드 시스템이 Fragment를 재생성할 때 문제가 발생할 수 있습니다.
• FragmentFactory를 사용하면, 기본 생성자를 사용하지 않고도 의존성 주입을 통해 Fragment를 생성할 수 있으며, 시스템에서 재생성할 때도 문제없이 사용할 수 있습니다.

참고

https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentFactory

https://sonseungha.tistory.com/657