หน้านี้แสดงแนวทางปฏิบัติแนะนำและคำแนะนำเกี่ยวกับสถาปัตยกรรมหลายรายการ นำไปใช้เพื่อปรับปรุงคุณภาพ ความเสถียร และความสามารถในการปรับขนาดของแอป นอกจากนี้ยังช่วยให้ดูแลรักษาและทดสอบแอปได้ง่ายขึ้นด้วย
แนวทางปฏิบัติแนะนำด้านล่างจัดกลุ่มตามหัวข้อ แต่ละรายการจะมีลำดับความสำคัญที่แสดงให้เห็นว่าคำแนะนำนั้นมีประโยชน์มากน้อยเพียงใด โดยมีลำดับความสำคัญดังนี้
- แนะนำเป็นอย่างยิ่ง: นำแนวทางปฏิบัตินี้ไปใช้ เว้นแต่จะขัดแย้งกับแนวทางของคุณโดยพื้นฐาน
- แนะนำ: แนวทางปฏิบัตินี้มีแนวโน้มที่จะปรับปรุงแอปของคุณ
- ไม่บังคับ: แนวทางปฏิบัตินี้สามารถปรับปรุงแอปของคุณได้ในบางสถานการณ์
สถาปัตยกรรมแบบเลเยอร์
สถาปัตยกรรมแบบเลเยอร์ที่เราแนะนำจะเน้นการแยกส่วนที่เกี่ยวข้อง โดยจะขับเคลื่อน UI จากโมเดลข้อมูล เป็นไปตามหลักการแหล่งข้อมูลที่เชื่อถือได้เพียงแหล่งเดียว (SSOT) และเป็นไปตามหลักการการไหลของข้อมูลแบบทิศทางเดียว แนวทางปฏิบัติแนะนำบางส่วนสำหรับสถาปัตยกรรมแบบเลเยอร์มีดังนี้
| คำแนะนำ | คำอธิบาย |
|---|---|
| ใช้ชั้นข้อมูลที่กำหนดไว้อย่างชัดเจน
แนะนำอย่างยิ่ง |
ชั้นข้อมูลจะแสดงข้อมูลแอปพลิเคชันต่อส่วนที่เหลือของแอป และมีตรรกะทางธุรกิจส่วนใหญ่ของแอป
|
| ใช้เลเยอร์ UI ที่กำหนดไว้อย่างชัดเจน
แนะนำอย่างยิ่ง |
เลเยอร์ UI จะแสดงข้อมูลแอปพลิเคชันบนหน้าจอและทำหน้าที่เป็นจุดหลักของการโต้ตอบของผู้ใช้ Jetpack Compose เป็นชุดเครื่องมือสมัยใหม่ที่แนะนำสำหรับการสร้าง UI ของแอป
|
| แสดงข้อมูลแอปพลิเคชันจากชั้นข้อมูลโดยใช้ที่เก็บข้อมูล
แนะนำอย่างยิ่ง |
ตรวจสอบว่าคอมโพเนนต์ในเลเยอร์ UI เช่น Composable หรือ ViewModel ไม่ได้โต้ตอบกับแหล่งข้อมูลโดยตรง ตัวอย่างแหล่งข้อมูล ได้แก่
|
| ใช้ Coroutines และ Flow
แนะนำอย่างยิ่ง |
ใช้ Coroutine และ Flow เพื่อสื่อสารระหว่างเลเยอร์
ดูข้อมูลเพิ่มเติมเกี่ยวกับแนวทางปฏิบัติแนะนำสำหรับโครูทีนได้ที่แนวทางปฏิบัติแนะนำสำหรับโครูทีนใน Android |
| ใช้เลเยอร์โดเมน
แนะนำในแอปขนาดใหญ่ |
ใช้เลเยอร์โดเมนกับ Use Case หากต้องการใช้ตรรกะทางธุรกิจซ้ำซึ่งโต้ตอบกับชั้นข้อมูลใน ViewModel หลายรายการ หรือต้องการลดความซับซ้อนของตรรกะทางธุรกิจของ ViewModel หนึ่งๆ |
เลเยอร์ UI
บทบาทของเลเยอร์ UI คือการแสดงข้อมูลแอปพลิเคชันบนหน้าจอและทำหน้าที่เป็นจุดหลักของการโต้ตอบของผู้ใช้ แนวทางปฏิบัติแนะนำบางส่วนสำหรับเลเยอร์ UI มีดังนี้
| คำแนะนำ | คำอธิบาย |
|---|---|
| ทำตามโฟลว์ข้อมูลแบบทิศทางเดียว (UDF)
แนะนำอย่างยิ่ง |
ปฏิบัติตามหลักการการไหลของข้อมูลแบบทิศทางเดียว (UDF) ซึ่ง ViewModel จะแสดงสถานะ UI โดยใช้รูปแบบผู้สังเกตการณ์และรับการดำเนินการจาก UI ผ่านการเรียกใช้เมธอด |
| ใช้ AAC ViewModel หากแอปของคุณได้รับประโยชน์จาก ViewModel ดังกล่าว
แนะนำอย่างยิ่ง |
ใช้ AAC ViewModel เพื่อจัดการตรรกะทางธุรกิจ และดึงข้อมูลแอปพลิเคชันเพื่อแสดงสถานะ UI ต่อ UI
ดูข้อมูลเพิ่มเติมเกี่ยวกับแนวทางปฏิบัติแนะนำสำหรับ ViewModel ได้ที่คำแนะนำเกี่ยวกับสถาปัตยกรรม ดูข้อมูลเพิ่มเติมเกี่ยวกับประโยชน์ของ ViewModel ได้ที่ViewModel เป็นตัวเก็บสถานะตรรกะทางธุรกิจ |
| ใช้การรวบรวมสถานะ UI ที่คำนึงถึงวงจรชีวิต
แนะนำอย่างยิ่ง |
รวบรวมสถานะ UI จาก UI โดยใช้เครื่องมือสร้าง Coroutine ที่รับรู้ถึงวงจรชีวิตที่เหมาะสม collectAsStateWithLifecycle
อ่านเพิ่มเติมเกี่ยวกับ |
| อย่าส่งเหตุการณ์จาก ViewModel ไปยัง UI
แนะนำอย่างยิ่ง |
ประมวลผลเหตุการณ์ทันทีใน ViewModel และทำให้เกิดการอัปเดตสถานะพร้อมผลลัพธ์ของการจัดการเหตุการณ์ ดูข้อมูลเพิ่มเติมเกี่ยวกับเหตุการณ์ UI ได้ที่จัดการเหตุการณ์ ViewModel |
| ใช้แอปพลิเคชันกิจกรรมเดียว
แนะนำอย่างยิ่ง |
ใช้ Navigation 3 เพื่อไปยังหน้าจอต่างๆ และทำ Deep Link ไปยังแอปหากแอปมีมากกว่า 1 หน้าจอ |
| ใช้ Jetpack Compose
แนะนำอย่างยิ่ง |
ใช้ Jetpack Compose เพื่อสร้างแอปใหม่สำหรับโทรศัพท์ แท็บเล็ต อุปกรณ์แบบพับได้ และ Wear OS |
ข้อมูลโค้ดต่อไปนี้แสดงวิธีรวบรวมสถานะ UI ในลักษณะที่รับรู้ถึงวงจรชีวิต
@Composable
fun MyScreen(
viewModel: MyViewModel = viewModel()
) {
val uiState by viewModel.uiState.collectAsStateWithLifecycle()
}
ViewModel
ViewModels มีหน้าที่รับผิดชอบในการระบุสถานะ UI และเข้าถึงชั้นข้อมูล แนวทางปฏิบัติแนะนำบางส่วนสำหรับ ViewModel มีดังนี้
| คำแนะนำ | คำอธิบาย |
|---|---|
| ทำให้ ViewModel เป็นอิสระจากวงจรของ Android
แนะนำอย่างยิ่ง |
ใน ViewModel อย่าเก็บการอ้างอิงไปยังประเภทที่เกี่ยวข้องกับวงจร อย่าส่ง Activity, Context หรือ Resources เป็นทรัพยากร Dependency
หากมีบางสิ่งที่ต้องใช้ Context ใน ViewModel ให้ประเมินอย่างรอบคอบว่าสิ่งนั้นอยู่ในเลเยอร์ที่ถูกต้องหรือไม่ |
| ใช้ Coroutines และ Flow
แนะนำอย่างยิ่ง |
ViewModel จะโต้ตอบกับข้อมูลหรือเลเยอร์โดเมนโดยใช้สิ่งต่อไปนี้
|
| ใช้ ViewModel ที่ระดับหน้าจอ
แนะนำอย่างยิ่ง |
อย่าใช้ ViewModel ในส่วนที่นำมาใช้ซ้ำได้ของ UI คุณควรใช้ ViewModel ในกรณีต่อไปนี้
สำหรับ Composable ที่ซับซ้อนมากขึ้นหรือมีลักษณะการทำงานแบบไดนามิกตามสถานะ ให้ใช้ |
| ใช้คลาสตัวเก็บสถานะธรรมดาในคอมโพเนนต์ UI ที่นำกลับมาใช้ใหม่ได้
แนะนำอย่างยิ่ง |
ใช้คลาสตัวเก็บสถานะธรรมดาเพื่อจัดการความซับซ้อนในคอมโพเนนต์ UI ที่นำกลับมาใช้ใหม่ได้ เมื่อทำเช่นนี้ คุณจะยกและควบคุมสถานะจากภายนอกได้ |
อย่าใช้ AndroidViewModel
แนะนำให้ใช้ |
ใช้คลาส ViewModel ไม่ใช่ AndroidViewModel อย่าใช้คลาส Application ใน ViewModel แต่ให้ย้ายทรัพยากร Dependency ไปยัง UI หรือชั้นข้อมูลแทน |
| แสดงสถานะ UI
แนะนำให้ใช้ |
ทำให้ ViewModel แสดงข้อมูลต่อ UI ผ่านพร็อพเพอร์ตี้เดียวที่ชื่อว่า uiState หาก UI แสดงข้อมูลหลายรายการที่ไม่เกี่ยวข้อง VM จะแสดงพร็อพเพอร์ตี้สถานะ UI หลายรายการได้
|
ข้อมูลโค้ดต่อไปนี้แสดงวิธีแสดงสถานะ UI จาก ViewModel
@HiltViewModel
class BookmarksViewModel @Inject constructor(
newsRepository: NewsRepository
) : ViewModel() {
val feedState: StateFlow<NewsFeedUiState> =
newsRepository
.getNewsResourcesStream()
.mapToFeedState(savedNewsResourcesState)
.stateIn(
scope = viewModelScope,
started = SharingStarted.WhileSubscribed(5_000),
initialValue = NewsFeedUiState.Loading
)
// ...
}
อายุการใช้งาน
ทำตามแนวทางปฏิบัติแนะนำสำหรับการทำงานกับวงจรกิจกรรม ดังนี้
| คำแนะนำ | คำอธิบาย |
|---|---|
ใช้เอฟเฟกต์ที่รับรู้ถึงวงจรใน Composable แทนการลบล้าง Lifecycle Callback Activity
แนะนำอย่างยิ่ง |
อย่าลบล้างเมธอดวงจรของ
|
ข้อมูลโค้ดต่อไปนี้แสดงวิธีดำเนินการตามสถานะวงจรที่กำหนด
@Composable
fun LocationChangedEffect(
locationManager: LocationManager,
onLocationChanged: (Location) -> Unit
) {
val currentOnLocationChanged by rememberUpdatedState(onLocationChanged)
LifecycleStartEffect(locationManager) {
val listener = LocationListener { newLocation ->
currentOnLocationChanged(newLocation)
}
try {
locationManager.requestLocationUpdates(
LocationManager.GPS_PROVIDER,
1000L,
1f,
listener,
)
} catch (e: SecurityException) {
// TODO: Handle missing permissions
}
onStopOrDispose {
locationManager.removeUpdates(listener)
}
}
}
จัดการทรัพยากร Dependency
ทำตามแนวทางปฏิบัติแนะนำเมื่อจัดการทรัพยากร Dependency ระหว่างคอมโพเนนต์ ดังนี้
| คำแนะนำ | คำอธิบาย |
|---|---|
| ใช้การแทรกทรัพยากร Dependency
แนะนำอย่างยิ่ง |
ใช้แนวทางปฏิบัติแนะนำสำหรับการแทรกทรัพยากร Dependency โดยเฉพาะการแทรกเครื่องมือสร้างเมื่อเป็นไปได้ |
| กำหนดขอบเขตให้กับคอมโพเนนต์เมื่อจำเป็น
แนะนำอย่างยิ่ง |
กำหนดขอบเขตเป็นคอนเทนเนอร์ทรัพยากร Dependency เมื่อประเภทมีข้อมูลที่เปลี่ยนแปลงได้ซึ่งจำเป็นต้องแชร์ หรือประเภทนั้นใช้ทรัพยากรมากในการเริ่มต้นและมีการใช้กันอย่างแพร่หลายในแอป |
| ใช้ Hilt
แนะนำให้ใช้ |
ใช้ Hilt หรือการแทรก Dependency ด้วยตนเองในแอปที่เรียบง่าย ใช้ Hilt หากโปรเจ็กต์มีความซับซ้อนมากพอ เช่น หากมีสิ่งต่อไปนี้
|
การทดสอบ
แนวทางปฏิบัติแนะนำบางส่วนสำหรับการทดสอบมีดังนี้
| คำแนะนำ | คำอธิบาย |
|---|---|
| รู้ว่าควรทดสอบอะไร
แนะนำอย่างยิ่ง |
ทดสอบโปรเจ็กต์ เว้นแต่ว่าโปรเจ็กต์นั้นจะเป็นแอป "Hello World" ที่เรียบง่าย โดยอย่างน้อยต้องมีข้อมูลต่อไปนี้
|
| ใช้ Fake แทน Mock
แนะนำอย่างยิ่ง |
ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้ Fake ได้ที่ใช้ Test Double ใน Android |
| ทดสอบ StateFlow
แนะนำอย่างยิ่ง |
เมื่อทดสอบ StateFlow ให้ทำดังนี้
|
ดูข้อมูลเพิ่มเติมได้ที่สิ่งที่ควรทดสอบใน Android และทดสอบเลย์เอาต์ Compose
ประสิทธิภาพ
แนวทางปฏิบัติแนะนำบางส่วนในการปรับปรุงประสิทธิภาพมีดังนี้
| คำแนะนำ | คำอธิบาย |
|---|---|
| ใช้ R8 เพื่อลดขนาดและเพิ่มประสิทธิภาพแอป
แนะนำอย่างยิ่ง |
เปิดใช้ R8 ในโหมดเต็มรูปแบบในการกำหนดค่าบิลด์เพื่อนำโค้ดที่ไม่ได้ใช้ออก ปรับคลาสให้ยากต่อการอ่าน และเขียนโค้ดใหม่เพื่อปรับปรุงประสิทธิภาพรันไทม์ |
| ใช้โปรไฟล์พื้นฐานและโปรไฟล์การเริ่มต้นระบบ
แนะนำอย่างยิ่ง |
สร้าง Baseline Profile และ Startup Profile เพื่อคอมไพล์เส้นทางโค้ดที่สำคัญล่วงหน้า ซึ่งจะช่วยลดเวลาในการตอบสนองของการเริ่มต้น (TTID และ TTFD) ได้อย่างมาก รวมถึงลดอาการกระตุกและ ANR ด้วย |
| ทดสอบประสิทธิภาพด้วย Macrobenchmark
แนะนำอย่างยิ่ง |
ใช้ไลบรารี Macrobenchmark เพื่อทดสอบประสิทธิภาพของแอปและป้องกันการถดถอย |
โมเดล
โปรดปฏิบัติตามแนวทางปฏิบัติแนะนำต่อไปนี้เมื่อพัฒนาโมเดลในแอป
| คำแนะนำ | คำอธิบาย |
|---|---|
| สร้างโมเดลต่อเลเยอร์ในแอปที่ซับซ้อน
แนะนำให้ใช้ |
ในแอปที่ซับซ้อน ให้สร้างโมเดลใหม่ในเลเยอร์หรือคอมโพเนนต์ต่างๆ ตามความเหมาะสม ลองดูตัวอย่างต่อไปนี้
|
รูปแบบการตั้งชื่อ
เมื่อตั้งชื่อฐานของโค้ด คุณควรคำนึงถึงแนวทางปฏิบัติแนะนำต่อไปนี้
| คำแนะนำ | คำอธิบาย |
|---|---|
| วิธีการตั้งชื่อ
ไม่บังคับ |
ใช้คำกริยาเพื่อตั้งชื่อเมธอด เช่น makePayment() |
| การตั้งชื่อพร็อพเพอร์ตี้
ไม่บังคับ |
ใช้นามวลีเพื่อตั้งชื่อพร็อพเพอร์ตี้ เช่น inProgressTopicSelection |
| การตั้งชื่อสตรีมข้อมูล
ไม่บังคับ |
เมื่อคลาสแสดงสตรีม Flow หรือสตรีมอื่นๆ รูปแบบการตั้งชื่อจะเป็น get{model}Stream เช่น getAuthorStream(): Flow<Author>
หากฟังก์ชันแสดงรายการโมเดล ให้ใช้ชื่อโมเดลพหูพจน์: getAuthorsStream(): Flow<List<Author>> |
| การตั้งชื่อการใช้งานอินเทอร์เฟซ
ไม่บังคับ |
ใช้ชื่อที่มีความหมายสำหรับการติดตั้งใช้งานอินเทอร์เฟซ ใช้ Default เป็นคำนำหน้าหากไม่พบชื่อที่ดีกว่า ตัวอย่างเช่น สำหรับอินเทอร์เฟซ NewsRepository คุณอาจมี OfflineFirstNewsRepository หรือ InMemoryNewsRepository หากไม่พบชื่อที่เหมาะสม ให้ใช้ DefaultNewsRepository
ใส่คำนำหน้าการติดตั้งใช้งานปลอมด้วย Fake เช่น FakeAuthorsRepository |
แหล่งข้อมูลเพิ่มเติม
ดูข้อมูลเพิ่มเติมเกี่ยวกับสถาปัตยกรรม Android ได้ที่แหล่งข้อมูลเพิ่มเติมต่อไปนี้