android trinity

Android-Trinity

นี่คือเฟรมเวิร์กเล็ก ๆ ที่มีรหัสนั่งร้านส่วนใหญ่ (พร้อมยูทิลิตี้ที่ดีและซอร์สโค้ดที่เตรียมไว้) จำเป็นต้องเริ่มต้น แอปพลิเคชัน Android ใหม่

พื้นหลัง?

ใช่ Android Studio อาจสร้างโครงการให้คุณ แต่มีชิ้นส่วนที่ขาดหายไปซึ่งฉัน มัก จะเพิ่มทุกโครงการที่ฉันสร้าง เฟรมเวิร์กเล็ก ๆ นี้ (ฉันจะบอกว่ารหัสนั่งร้านยังคงอยู่) มีจุดมุ่งหมายเพื่อแก้ปัญหานี้โดยการสร้างโครงการ Android ด้วยการสร้างบล็อกพื้นฐาน ตรวจสอบส่วน สิ่งที่ต้องทำ ด้านล่างสำหรับข้อมูลเพิ่มเติมเกี่ยวกับวิวัฒนาการและความคืบหน้า

Android-Trinity จัดเตรียมอะไรไว้บ้าง? -

เสรีภาพ. มันใช้เครื่องมือมาตรฐาน แต่จัดระเบียบในลักษณะที่อำนวยความสะดวกในการพัฒนา Android คุณสามารถ refactor หรือเปลี่ยนแปลงอะไรก็ได้ แต่ความคิดคือการมีจุดเริ่มต้นที่แข็งแกร่ง การเดินสายทั้งหมดทำเพื่อคุณด้วยความยืดหยุ่นในการแก้ไขตามความต้องการของคุณ

• Kotlin DSL โดยค่าเริ่มต้นที่ Gradle Build System Leve
• รายงานรหัส analisis แบบสแตติก (Detekt)
• รายงานการครอบคลุมรหัส (Jacoco)
• คลาสพื้นฐาน: BaseActivity และ BaseFragments
• แถบเครื่องมือพร้อมสไตล์ที่กำหนดไว้ล่วงหน้า
• Clases ทดสอบก่อนการตั้งค่า: UnitTest , AndroidTest , AcceptanceTest
• สคริปต์ Gradle ที่คอมไพล์ล่วงหน้า (โฟลเดอร์ buildScr ) จัดโดยด้าน:
  • compilation.gradle.kts
  • infrastructure.gradle.kts
  • quality.gradle.kts
  • variants.gradle.kts
• การจัดการการพึ่งพาในที่เดียว: Dependencies.kt
• รั่วไหลสำหรับการตรวจจับการรั่วไหล
• ตัวแปรบิลด์ที่กำหนดไว้ล่วงหน้า (ตรวจสอบ variants.gradle.kts ไฟล์)
  • สร้างประเภท:
    • DEBUG
    • RELEASE
  • รสชาติของผลิตภัณฑ์:
    • DEV
    • INTERNAL
    • PUBLIC
• Kotlin coroutines
• เฟรมเวิร์กฟีเจอร์ฟีเจอร์ขนาดกะทัดรัด

Android-Trinity ไม่รวมอะไร? (มีแนวโน้มที่จะเปลี่ยนแปลงหากจำเป็นในรุ่นอนาคต)

• Di. คุณควรเลือกกรอบการฉีดพึ่งพาของคุณ
• ไม่มีกรอบการนำทาง
• ไม่มีไลบรารี LiveData และ ViewModel เนื่องจากวิศวกรบางคนอาจใช้วิธีการอื่นในระดับ UI เช่น MVI, MVP ฯลฯ
• ไม่มีการไหลของ Kotlin
• ไม่มีเลย์เอาต์ UI สำหรับการรองรับแท็บเล็ตหรือ Android TV

งาน Gradle ที่กำหนดไว้ล่วงหน้า

• ./gradlew runStaticAnalysis
• ./gradlew runTestCoverage
• ./gradlew runUnitTests
• ./gradlew runAcceptanceTests
• ./gradlew compileApp
• ./gradlew runApp

ใช้อย่างไร?

ในขณะที่มีขั้นตอนด้วยตนเองสองสามขั้นตอนที่เกี่ยวข้องตั้งแต่เราอยู่ในช่วงแรก แต่เราเชื่อในวิวัฒนาการของโซฟแวร์ใช่ไหม ดังนั้นคอยติดตามและตรวจสอบทั้ง วิธีการมีส่วนร่วม และส่วน รายการสิ่งที่ต้องทำ

• ขั้นตอนที่ 1: คลิกเพื่อสร้าง repo ใหม่
• ขั้นตอนที่ 2: นำเข้าโครงการใน Android Studio
• ขั้นตอนที่ 3: เปลี่ยนชื่อแพ็คเกจตามความต้องการของคุณ com.fernandocejas.sample โดยค่าเริ่มต้น

ใช้ผู้ช่วยทดสอบ

สมมติว่าคุณต้องการเขียนการทดสอบ (และคุณควรทำ เสมอ ) ตามที่กล่าวไว้ว่ามี 3 ชั้นเรียนที่เข้ามาเล่นและนี่คือตัวอย่างของการใช้งาน:

• UnitTest.kt : ชั้นฐานทดสอบหน่วยที่ติดตั้ง mocks สำหรับคุณ (คุณใช้คำอธิบายประกอบ @Mockk เท่านั้น)

 class FeatureFlagTest : UnitTest () {

    @Mockk prival val yourMock

    @Test
    fun `given a feature flag, when it is activated, then executes given logic block` () {
        val activeFlag = ActiveFeatureFlag ()
        val fakeNavigator = mockk< Navigator >(relaxed = true )

        activeFlag whenActivated {
            fakeNavigator.doSomething()
            fakeNavigator.navigateToActiveFeature()
            fakeNavigator.doSomething()
        }

        verify(exactly = 1 ) { fakeNavigator.navigateToActiveFeature() }
        verify(exactly = 2 ) { fakeNavigator.doSomething() }
    }

• AndroidTest.kt : คลาสฐานทดสอบการรวมซึ่งตั้งค่าการจำลองสำหรับคุณ (คุณใช้คำอธิบายประกอบ @Mockk เท่านั้น) คุณอาจใช้คลาสนี้เมื่อพวกเขาเป็นส่วนประกอบ Android ที่เกี่ยวข้อง มันถูกสำรองโดย robolectric

 class YourTestClass : AndroidTest () {

    @Mockk prival val yourMock

    @Test
    fun `given something, when something happens, then do something` () {
        TODO ()
    }

• AcceptanceTest.kt : UI Test Base Class ซึ่งตั้งค่าเอสเพรสโซ่สำหรับคุณ

 class MainActivityTest : AcceptanceTest ( MainActivity : :class.java) {

    @Test
    fun checkToolBarTest () {
        onView(withId( R .id.toolbar)).check(matches(isDisplayed()))
    }
}

ฟีเจอร์ธง

Android-Trinity มีกรอบการตั้งค่าสถานะออฟไลน์ที่เรียบง่ายพร้อม API ที่ง่ายมากที่สร้างขึ้นในเวลาคอมไพล์ หากคุณต้องการข้อมูลเพิ่มเติมโปรดดูคำขอดึงที่แนะนำ (TODO: เพิ่มเอกสารเพิ่มเติม)

ตัวอย่างการใช้งาน:

 Flag . Hello whenActivated { displayGreeting( R .string.hello) }

รายงานคุณภาพ: การวิเคราะห์แบบคงที่

• เครื่องมือที่เลือกไว้ที่นี่คือ detekt เนื่องจากลักษณะของ Kotlin
• งาน Gradlew และการกำหนดค่าสามารถพบได้ในไฟล์ quality.gradle.kts
• กฎ CCONFiguration อยู่ใน config/detekt/detekt.yml

รายงานคุณภาพ: การครอบคลุมรหัส

• เครื่องมือที่เลือกที่นี่คือ Jacoco เนื่องจากธรรมชาติและความนิยมในชุมชน
• งาน Gradlew และการกำหนดค่าสามารถพบได้ในไฟล์ quality.gradle.kts

รายการสิ่งที่ต้องทำ

• งาน Gradle สำหรับการเผยแพร่ไปยัง Google Play: แอพ Bundles
• ทำให้กระบวนการโดยอัตโนมัติจาก วิธีการใช้ ส่วน: ไอเดีย: ./gradlew setupProject
• ธงฟีเจอร์ท้องถิ่น
• เปลี่ยนชื่อแพ็คเกจเริ่มต้นเป็น io.android-trinity หรือ io.android.trinity
• -
• -

วิธีการมีส่วนร่วม

ไม่มีอะไรตั้งอยู่ในหินที่นี่และสิ่งต่าง ๆ สามารถเปลี่ยนแปลงและวิวัฒนาการได้ตามงานและข้อกำหนดของชุมชน ดังนั้นหากคุณต้องการมีส่วนร่วมอย่าลังเลที่จะเปิดปัญหาและติดฉลากอย่างถูกต้อง: บั๊ก การปรับปรุง ฯลฯ หรือส่ง PR โปรดทั้งคู่พร้อมคำอธิบายที่ดีเกี่ยวกับความตั้งใจเพื่ออำนวยความสะดวกในการตรวจสอบ

ใบอนุญาต

 Copyright 2021 Fernando Cejas

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.