วิธีรับ Context ใน Android MVVM ViewModel

ฉันพยายามใช้รูปแบบ MVVM ในแอป Android ของฉัน ฉันได้อ่านแล้วว่า ViewModels ไม่ควรมีรหัสเฉพาะของ Android (เพื่อให้การทดสอบง่ายขึ้น) อย่างไรก็ตามฉันต้องใช้บริบทสำหรับสิ่งต่างๆ (การรับทรัพยากรจาก xml การกำหนดค่าเริ่มต้น ฯลฯ ) วิธีที่ดีที่สุดในการทำคืออะไร? ฉันเห็นว่าAndroidViewModelมีการอ้างอิงถึงบริบทของแอปพลิเคชัน แต่มีรหัสเฉพาะของ Android ดังนั้นฉันไม่แน่ใจว่าควรอยู่ใน ViewModel หรือไม่ รวมถึงสิ่งเหล่านั้นในกิจกรรมวงจรชีวิตของกิจกรรมด้วย แต่ฉันใช้กริชเพื่อจัดการขอบเขตของส่วนประกอบดังนั้นฉันไม่แน่ใจว่าจะส่งผลอย่างไร ฉันยังใหม่กับรูปแบบ MVVM และ Dagger ดังนั้นขอขอบคุณทุกความช่วยเหลือ!

คุณสามารถใช้Applicationบริบทที่จัดทำโดยAndroidViewModelคุณควรขยายAndroidViewModelซึ่งเป็นเพียงViewModelการApplicationอ้างอิงที่มี

สำหรับโมเดลมุมมองส่วนประกอบสถาปัตยกรรม Android

ไม่ใช่แนวทางปฏิบัติที่ดีที่จะส่งต่อบริบทกิจกรรมของคุณไปยัง ViewModel ของกิจกรรมเนื่องจากหน่วยความจำรั่วไหล

ดังนั้นเพื่อให้ได้ในบริบทของคุณ ViewModel ชั้น ViewModel ควรขยายAndroid ดูรุ่นคลาส ด้วยวิธีนี้คุณจะได้รับบริบทดังที่แสดงในโค้ดตัวอย่างด้านล่าง

class ActivityViewModel(application: Application) : AndroidViewModel(application) {

    private val context = getApplication<Application>().applicationContext

    //... ViewModel methods 

}

ไม่ใช่ว่า ViewModels ไม่ควรมีโค้ดเฉพาะของ Android เพื่อให้การทดสอบง่ายขึ้นเนื่องจากเป็นนามธรรมที่ทำให้การทดสอบง่ายขึ้น

สาเหตุที่ ViewModels ไม่ควรมีอินสแตนซ์ของบริบทหรือสิ่งใด ๆ เช่นมุมมองหรือวัตถุอื่น ๆ ที่ยึดกับบริบทเป็นเพราะมันมีวงจรชีวิตที่แยกจากกิจกรรมและส่วนย่อย

สิ่งที่ฉันหมายถึงนี้คือสมมติว่าคุณทำการเปลี่ยนแปลงการหมุนเวียนในแอปของคุณ สิ่งนี้ทำให้กิจกรรมและ Fragment ของคุณทำลายตัวเองเพื่อสร้างตัวเองขึ้นมาใหม่ ViewModel มีไว้เพื่อคงอยู่ในสถานะนี้ดังนั้นจึงมีโอกาสที่จะเกิดข้อขัดข้องและมีข้อยกเว้นอื่น ๆ เกิดขึ้นหากยังคงมี View หรือ Context ของกิจกรรมที่ถูกทำลาย

สำหรับวิธีที่คุณควรทำในสิ่งที่คุณต้องการทำ MVVM และ ViewModel ทำงานได้ดีกับส่วนประกอบ Databinding ของ JetPack โดยทั่วไปแล้วคุณมักจะเก็บ String, int หรืออื่น ๆ สำหรับสิ่งต่างๆคุณสามารถใช้ Databinding เพื่อให้ Views แสดงได้โดยตรงดังนั้นจึงไม่จำเป็นต้องเก็บค่าไว้ใน ViewModel

แต่ถ้าคุณไม่ต้องการ Databinding คุณยังสามารถส่ง Context ภายในตัวสร้างหรือวิธีการเพื่อเข้าถึงทรัพยากรได้ อย่าถืออินสแตนซ์ของบริบทนั้นไว้ใน ViewModel ของคุณ

คำตอบสั้น ๆ - อย่าทำเช่นนี้

ทำไม?

มันเอาชนะจุดประสงค์ทั้งหมดของโมเดลมุมมอง

เกือบทุกอย่างที่คุณสามารถทำได้ใน view model สามารถทำได้ใน activity / fragment โดยใช้อินสแตนซ์ LiveData และแนวทางอื่น ๆ ที่แนะนำ

สิ่งที่ฉันทำแทนที่จะมีบริบทโดยตรงใน ViewModel ฉันสร้างคลาสผู้ให้บริการเช่น ResourceProvider ที่จะให้ทรัพยากรที่ฉันต้องการและฉันมีการฉีดคลาสผู้ให้บริการเหล่านั้นลงใน ViewModel ของฉัน

TL; DR: ใส่บริบทของแอปพลิเคชันผ่าน Dagger ใน ViewModels ของคุณและใช้เพื่อโหลดทรัพยากร หากคุณต้องการโหลดภาพให้ส่งอินสแตนซ์ View ผ่านอาร์กิวเมนต์จากวิธีการ Databinding และใช้บริบท View นั้น

MVVM เป็นสถาปัตยกรรมที่ดีและเป็นอนาคตของการพัฒนา Android อย่างแน่นอน แต่มีบางสิ่งที่ยังคงเป็นสีเขียว ยกตัวอย่างเช่นการสื่อสารเลเยอร์ในสถาปัตยกรรม MVVM ฉันเคยเห็นนักพัฒนารายอื่น (นักพัฒนาที่รู้จักกันดี) ใช้ LiveData เพื่อสื่อสารเลเยอร์ต่างๆในรูปแบบต่างๆ บางคนใช้ LiveData เพื่อสื่อสาร ViewModel กับ UI แต่จากนั้นใช้อินเทอร์เฟซการเรียกกลับเพื่อสื่อสารกับ Repositories หรือมี Interactors / UseCases และใช้ LiveData เพื่อสื่อสารกับพวกเขา จุดนี่คือว่าทุกอย่างไม่ได้เป็น 100% กำหนดเลย

ดังที่กล่าวมาแนวทางของฉันกับปัญหาเฉพาะของคุณคือการมีบริบทของแอปพลิเคชันที่พร้อมใช้งานผ่าน DI เพื่อใช้ใน ViewModels ของฉันเพื่อรับสิ่งต่างๆเช่น String จาก strings.xml ของฉัน

ถ้าฉันกำลังจัดการกับการโหลดรูปภาพฉันพยายามที่จะส่งผ่าน View object จากเมธอดอะแด็ปเตอร์ Databinding และใช้บริบทของ View เพื่อโหลดรูปภาพ ทำไม? เนื่องจากเทคโนโลยีบางอย่าง (เช่น Glide) อาจพบปัญหาหากคุณใช้บริบทของแอปพลิเคชันเพื่อโหลดรูปภาพ

หวังว่าจะช่วยได้!

ดังที่คนอื่น ๆ กล่าวถึงมีAndroidViewModelสิ่งที่คุณสามารถได้รับจากการรับแอปContextแต่จากสิ่งที่ฉันรวบรวมในความคิดเห็นคุณกำลังพยายามจัดการ@drawables จากภายในของคุณViewModelซึ่งเอาชนะจุดประสงค์ MVVM

โดยทั่วไปจำเป็นที่จะต้องมีContextในของคุณViewModelเกือบทุกแห่งแนะนำให้คุณควรพิจารณาทบทวนวิธีการที่คุณแบ่งตรรกะระหว่างคุณและViewViewModels

แทนที่จะมีการViewModelแก้ปัญหา drawables และป้อนไปยัง Activity / Fragment ให้พิจารณาให้ Fragment / Activity เล่นกล drawables ตามข้อมูลที่อยู่ในไฟล์ViewModel. สมมติว่าคุณต้องใช้ drawables ที่แตกต่างกันเพื่อแสดงในมุมมองสำหรับสถานะเปิด / ปิดซึ่งเป็นสิ่งViewModelที่ควรมีสถานะ (อาจเป็นบูลีน) แต่เป็นViewธุรกิจของการเลือก drawable ตามนั้น

สามารถทำได้ค่อนข้างง่ายด้วยDataBinding :

<ImageView
...
app:src="@{viewModel.isOn ? @drawable/switch_on : @drawable/switch_off}"
/>

หากคุณมีสถานะและสิ่งที่วาดได้มากขึ้นเพื่อหลีกเลี่ยงตรรกะที่ยุ่งยากในไฟล์เลย์เอาต์คุณสามารถเขียนBindingAdapterแบบกำหนดเองที่แปลพูดEnumค่าเป็นR.drawable.*(เช่นชุดการ์ด)

หรือบางทีคุณอาจจำเป็นต้องมีContextองค์ประกอบบางอย่างที่คุณใช้ภายในของคุณViewModel- แล้วสร้างองค์ประกอบภายนอกViewModel. และผ่านมันคุณสามารถใช้ DI หรือ singletons หรือสร้างContextขวาองค์ประกอบ -dependent ก่อน initialising ViewModelใน/FragmentActivity

ทำไมต้องกังวล: Contextเป็นสิ่งเฉพาะของ Android และขึ้นอยู่กับสิ่งที่อยู่ในViewModels เป็นแนวทางปฏิบัติที่ไม่ดี: พวกเขายืนอยู่ในลักษณะของการทดสอบหน่วย ในทางกลับกันอินเทอร์เฟซคอมโพเนนต์ / บริการของคุณเองอยู่ภายใต้การควบคุมของคุณอย่างเต็มที่ดังนั้นคุณจึงสามารถจำลองเพื่อทดสอบ

มีการอ้างอิงถึงบริบทของแอปพลิเคชันอย่างไรก็ตามมีรหัสเฉพาะของ Android

ข่าวดีคุณสามารถใช้Mockito.mock(Context.class)และทำให้บริบทส่งคืนสิ่งที่คุณต้องการในการทดสอบ!

ดังนั้นเพียงแค่ใช้ a ViewModelตามปกติและให้ ApplicationContext ผ่าน ViewModelProviders.Factory ตามปกติ

คุณสามารถเข้าถึงบริบทของแอปพลิเคชันgetApplication().getApplicationContext()จากภายใน ViewModel นี่คือสิ่งที่คุณต้องการเพื่อเข้าถึงทรัพยากรการตั้งค่า ฯลฯ ..

คุณไม่ควรใช้วัตถุที่เกี่ยวข้องกับ Android ใน ViewModel ของคุณเนื่องจากแรงจูงใจในการใช้ ViewModel คือการแยกรหัส java และรหัส Android เพื่อให้คุณสามารถทดสอบตรรกะทางธุรกิจของคุณแยกกันและคุณจะมีชั้นของส่วนประกอบ Android และตรรกะทางธุรกิจของคุณแยกกัน และข้อมูลคุณไม่ควรมีบริบทใน ViewModel ของคุณเนื่องจากอาจทำให้เกิดปัญหาได้

ผมมีปัญหาในการรับSharedPreferencesเมื่อใช้ระดับดังนั้นฉันเอาคำแนะนำจากคำตอบข้างต้นและได้ใช้ต่อไปViewModel AndroidViewModelตอนนี้ทุกอย่างดูดีมาก

สำหรับ AndroidViewModel

import android.app.Application;
import android.content.Context;
import android.content.SharedPreferences;

import androidx.lifecycle.AndroidViewModel;
import androidx.lifecycle.LiveData;
import androidx.lifecycle.MutableLiveData;
import androidx.preference.PreferenceManager;

public class HomeViewModel extends AndroidViewModel {

    private MutableLiveData<String> some_string;

    public HomeViewModel(Application application) {
        super(application);
        some_string = new MutableLiveData<>();
        Context context = getApplication().getApplicationContext();
        SharedPreferences preferences = PreferenceManager.getDefaultSharedPreferences(context);
        some_string.setValue("<your value here>"));
    }

}

และใน Fragment

import android.os.Bundle;
import android.util.Log;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.TextView;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.fragment.app.Fragment;
import androidx.lifecycle.Observer;
import androidx.lifecycle.ViewModelProviders;


public class HomeFragment extends Fragment {


    public View onCreateView(@NonNull LayoutInflater inflater,
                             ViewGroup container, Bundle savedInstanceState) {
        final View root = inflater.inflate(R.layout.fragment_home, container, false);
        HomeViewModel homeViewModel = ViewModelProviders.of(this).get(HomeViewModel.class);
        homeViewModel.getAddress().observe(getViewLifecycleOwner(), new Observer<String>() {
            @Override
            public void onChanged(@Nullable String address) {


            }
        });
        return root;
    }
}

ฉันสร้างมันด้วยวิธีนี้:

@Module
public class ContextModule {

    @Singleton
    @Provides
    @Named("AppContext")
    public Context provideContext(Application application) {
        return application.getApplicationContext();
    }
}

จากนั้นฉันเพิ่งเพิ่มใน AppComponent ContextModule.class:

@Component(
       modules = {
                ...
               ContextModule.class
       }
)
public interface AppComponent extends AndroidInjector<BaseApplication> {
.....
}

จากนั้นฉันก็ฉีดบริบทใน ViewModel ของฉัน:

@Inject
@Named("AppContext")
Context context;

ใช้รูปแบบต่อไปนี้:

class NameViewModel(
val variable:Class,application: Application):AndroidViewModel(application){
   body...
}

ปัญหาในการแทรกบริบทลงใน ViewModel คือบริบทสามารถเปลี่ยนแปลงได้ตลอดเวลาขึ้นอยู่กับการหมุนหน้าจอโหมดกลางคืนหรือภาษาของระบบและทรัพยากรที่ส่งคืนใด ๆ ก็สามารถเปลี่ยนแปลงได้ตามนั้น การส่งคืน ID ทรัพยากรอย่างง่ายทำให้เกิดปัญหาสำหรับพารามิเตอร์เพิ่มเติมเช่นการแทนที่ getString การส่งคืนผลลัพธ์ระดับสูงและการย้ายตรรกะการแสดงผลไปยังกิจกรรมทำให้ยากต่อการทดสอบ

วิธีแก้ปัญหาของฉันคือให้ ViewModel สร้างและส่งคืนฟังก์ชันที่เรียกใช้ในภายหลังผ่านบริบทของกิจกรรม น้ำตาลสังเคราะห์ของ Kotlin ทำให้เรื่องนี้ง่ายเหลือเชื่อ!

ViewModel.kt:

// connectedStatus holds a function that calls Context methods
// `this` can be elided
val connectedStatus = MutableLiveData<Context.() -> String> {
  // initial value
  this.getString(R.string.connectionStatusWaiting)
}
connectedStatus.postValue {
  this.getString(R.string.connectionStatusConnected, brand)
}

Activity.kt  // is a Context

override fun onCreate(_: Bundle?) {
  connectionViewModel.connectedStatus.observe(this) { it ->
   // runs the posted value with the given Context receiver
   txtConnectionStatus.text = this.run(it)
  }
}

สิ่งนี้ช่วยให้ ViewModel ถือตรรกะทั้งหมดสำหรับการคำนวณข้อมูลที่แสดงซึ่งตรวจสอบโดยการทดสอบหน่วยโดยที่กิจกรรมเป็นการแสดงที่เรียบง่ายมากโดยไม่มีตรรกะภายในเพื่อซ่อนข้อบกพร่อง