android trinity

Android-Trintial

這是啟動新的Android應用程序所需的許多腳手架代碼（帶有一些不錯的實用程序和準備好的源代碼）的小框架。

背景 ？

是的，Android Studio可能會為您創建一個項目，但是缺少零件，我總是將其添加到我創建的每個項目中。這個微小的框架（我想仍然腳手架代碼）旨在通過簡單而快速地使用基本構建塊創建一個Android項目來解決此問題。檢查下面的待辦事項部分以獲取有關演變和進度的更多信息。

Android-Trinity提供了什麼？ ？

自由。它使用標準工具，但以促進Android開發的方式組織。您可以重構或更改任何內容，但想法是具有強大的起點。所有的接線都是為您完成的，具有根據您的需求進行修改的靈活性。

• 默認情況下， Kotlin DSL在Gradle Build System Leve上。
• 靜態分析代碼報告（detekt）。
• 代碼覆蓋報告（Jacoco）。
• 基礎類別： BaseActivity和BaseFragments 。
• 工具欄帶有樣式預定義的樣式。
• 預集測試詞組： UnitTest ， AndroidTest ， AcceptanceTest 。
• 通過各個方面組織的預編譯Gradle腳本（ buildScr文件夾）：
  • compilation.gradle.kts
  • infrastructure.gradle.kts
  • quality.gradle.kts
  • variants.gradle.kts
• 依賴項管理在一個地方： Dependencies.kt
• 洩漏檢測洩漏。
• 預定義的構建變體（Check variants.gradle.kts文件）
  • 構建類型：
    • DEBUG
    • RELEASE
  • 產品口味：
    • DEV
    • INTERNAL
    • PUBLIC
• Kotlin Coroutines
• 緊湊的功能標誌框架

Android-Trintion不包括什麼？ （如果有必要，可能會在以後的版本中進行更改）

• di。您應該選擇依賴注入框架。
• 沒有導航框架。
• 沒有LiveData和ViewModel庫，因為一些工程師可能會在UI級別使用MVI，MVP等的其他方法。
• 沒有Kotlin流。
• 沒有用於平板電腦或Android電視支持的UI佈局。

預定義的Gradle任務

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

如何使用它？

目前，由於我們處於早期階段，因此涉及幾個手動步驟。但是我們相信Sofware Evolution對嗎？因此，請繼續關注並檢查如何貢獻和待辦事項列表部分。

• 步驟1：單擊以創建新的存儲庫。
• 步驟2：在Android Studio中導入該項目
• 步驟3：根據您的需求重命名軟件包。 com.fernandocejas.sample默認情況下。

使用測試助手

假設您想編寫測試（並且您應該始終進行），如前所述，有3個類別的班級，在這裡使用它們的用法示例：

• UnitTest.kt ：單位測試基類為您設置模擬（您僅使用@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測試基類哪個為您設置濃縮咖啡

 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) }

質量報告：靜態分析

• 此處選擇的工具是由於其對Kotlin的性質而進行的。
• Gradlew任務及其配置可以在quality.gradle.kts文件中找到。
• cconfiguration規則在config/detekt/detekt.yml中。

質量報告：代碼覆蓋範圍

• 此處選擇的工具是Jacoco，因為它在社區中的性質和知名度。
• Gradlew任務及其配置可以在quality.gradle.kts文件中找到。

待辦事項清單

• 出版到Google Play的Gradle任務：App 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.