Splitties

การแยก

Splitties เป็นคอลเลกชันของห้องสมุด Kotlin Multiplatform ขนาดเล็ก (พร้อม Android เป็นเป้าหมายแรก)

ไลบรารีเหล่านี้มีวัตถุประสงค์เพื่อลดจำนวนรหัสที่คุณต้องเขียนการปลดปล่อยรหัสการอ่านและการเขียนเวลาเพื่อให้คุณสามารถมุ่งเน้นไปที่สิ่งที่คุณต้องการสร้างสำหรับผู้ใช้ของคุณ (แม้ว่าคุณจะเป็นคนเดียว) หรือมี fun มากขึ้น

โครงการนี้มีชื่อว่า "Splitties" เพราะมันถูกแยกออกเป็นโมดูลขนาดเล็กกระจายเป็นห้องสมุดอิสระดังนั้นคุณสามารถเพิ่มเฉพาะสิ่งที่คุณต้องการในโครงการ/โมดูลของคุณช่วยลดขนาดของไบนารีสุดท้ายที่อุปกรณ์ผู้ใช้จะต้องดาวน์โหลดและเก็บไว้ในที่เก็บข้อมูล จำกัด (BTW ทุกอย่าง จำกัด )

โมดูลการกำหนดเป้าหมาย Android บางตัวมีเนื้อหาคล้ายกับที่ Anko เสนอ ดูการเปรียบเทียบสั้น ๆ ของการแยกกับ Anko ที่นี่

แต่ละโมดูลได้รับการออกแบบให้มี รอยเท้าขนาดเล็ก และมี ประสิทธิภาพ มากที่สุด

ตัวอย่างบางส่วน

Splitties เป็นเรื่องเกี่ยวกับการทำให้รหัสของคุณง่ายขึ้น นี่คือตัวอย่างบางส่วน:

Kotlin:

startActivity( Intent ( this , DemoActivity :: class .java))

Kotlin พร้อมกิจกรรมแยก:

start< DemoActivity >()

---

Kotlin:

 Snackbar .make(root, R .string.refresh_successful, Snackbar . LENGTH_SHORT )
    .show()

kotlin กับ splitties snackbar:

root.snack( R .string.refresh_successful)

---

Racing Coroutines: ( raceOf(…) มาจากโมดูล Coroutines)

 suspend fun awaitUserChoice ( ui : SomeUi , choices : List < Stuff >): Stuff ? = raceOf({
    ui.awaitSomeUserAction(choices)
}, {
    ui.awaitDismissal()
    null
}, {
    ui.showSomethingInRealtimeUntilCancelled() // Returns Nothing, will run, but never "win".
})

---

Kotlin:

 Snackbar .make(root, getString( R .string.deleted_x_items, deletedCount), Snackbar . LENGTH_LONG )
    .setAction(android. R .string.cancel) {
        deleteOperation.requestRollback()
    }
    .setActionTextColor( ContextCompat .getColor( this , R .color.fancy_color))
    .show()

kotlin กับ splitties snackbar:

root.longSnack(str( R .string.deleted_x_items, deletedCount)) {
    action(android. R .string.cancel, textColor = color( R .color.fancy_color)) {
        deleteOperation.requestRollback()
    }
}

---

ภาพรวม

• ปฏิสัมพันธ์ของระบบ (Android เท่านั้น)
• การป้อนข้อมูลผู้ใช้และส่วนต่อประสานผู้ใช้ที่เกี่ยวข้อง
  • ข้อความขนาดเล็ก (Android เท่านั้น)
  • บทสนทนา (Android เท่านั้น)
  • ระบบ UI (Android เท่านั้น)
  • ส่วนขยายสำหรับมุมมอง (Android เท่านั้น)
  • การสร้าง UIs ตามมุมมองด้วยพลังของ Kotlin (Android เท่านั้น)
  • ยูทิลิตี้ UI ต่างๆ (Android เท่านั้น)
  • ผู้ช่วยออกแบบวัสดุ (Android เท่านั้น)
• การสื่อสารระหว่างแอพระหว่างและข้าม: กิจกรรมชิ้นส่วนเจตนาและการรวมกลุ่ม
• พร้อมกัน (multiplatform)
• การคงอยู่ของข้อมูล (multiplatform)
• สาธารณูปโภค (Multiplatform)
• การดีบัก (Android เท่านั้น)
• มรดก (Android เท่านั้น)

การโต้ตอบของระบบ (Android เท่านั้น):

• บริบทแอพ: มี Context แอปพลิเคชันของคุณพร้อมกับ appCtx เสมอ
• บริการระบบ: ไม่มี context.getSystemService(NAME_OF_SERVICE) as NameOfManager

อินพุตของผู้ใช้และส่วนต่อประสานผู้ใช้ที่เกี่ยวข้อง:

ข้อความขนาดเล็ก (Android เท่านั้น)

• Snackbar: คว้าของว่างโดยไม่ทำพิธีพร้อม snack(…) และ longSnack(…)
• Toast: แสดงขนมปังปิ้งโดยเพียงแค่เรียก toast(yourText) และ Dodge API 25 BadTokenException

บทสนทนา (Android เท่านั้น)

• กล่องโต้ตอบการแจ้งเตือน: สร้างกล่องโต้ตอบการแจ้งเตือนอย่างง่ายด้วยรหัสง่าย
• Alert Dialog AppCompat: AppCompat เวอร์ชันของกล่องโต้ตอบการแจ้งเตือน
• การแจ้งเตือน Dialog AppCompat Coroutines: ฟังก์ชั่นส่วนขยาย showAndAwait สำหรับ AppCompat AlertDialog
• การแจ้งเตือนการโต้ตอบวัสดุ: ส่วนประกอบส่วนประกอบวัสดุของการแจ้งเตือนการแจ้งเตือน AppCompat

ระบบ UI (Android เท่านั้น)

• การอนุญาตที่เป็นอันตราย: ขออนุญาตรันไทม์โดยไม่ทำให้เกิดมลพิษ codebase ของคุณ

ส่วนขยายสำหรับมุมมอง (Android เท่านั้น)

• มุมมอง: ฟังก์ชั่นส่วนขยายและคุณสมบัติใน View
• ดู AppCompat: AppCompat Extension of Views รวมถึงผู้ช่วยสำหรับการย้อมสี ImageView , ActionBar และ Tooltip
• ดู CardView: CardView Extension of Views จัดเตรียมคุณสมบัติของ contentPadding
• Views Material: ส่วนประกอบของวัสดุการขยายมุมมอง
• มุมมอง Coroutines วัสดุ: ส่วนประกอบวัสดุ + kotlin coroutines
• ดู Recyclerview: Recyclerview Extension of Views
• Views Coroutines: Android Views + Kotlin Coroutines

การสร้าง UIs ตามมุมมองด้วยพลังของ Kotlin (Android เท่านั้น)

• มุมมอง DSL: สร้าง UIS ด้วยรหัส Kotlin ที่อ่านได้ (รองรับตัวอย่าง IDE)
• ดู DSL AppCompat: ส่วนขยายของ AppCompat ของ Views DSL
• ดู DSL Constraintlayout: ข้อ จำกัด ของการขยายมุมมอง DSL
• ดู DSL CoordinatorLayout: CoordinatorLayout Extension of Views DSL
• Views DSL วัสดุ: ส่วนประกอบของวัสดุการขยายมุมมอง DSL
• ดู DSL Recyclerview: Recyclerview Extension of Views DSL

ยูทิลิตี้ UI ต่างๆ (Android เท่านั้น)

• ทรัพยากร: ส่วนขยายเพื่อรับทรัพยากรเช่นสตริงสีหรือ drawables ได้อย่างง่ายดายด้วยการสนับสนุนคุณลักษณะที่มีธีม
• ขนาด: ส่วนขยาย Android dp สำหรับ View และ Context มีประโยชน์โดยเฉพาะอย่างยิ่งเมื่อใช้ Views DSL
• มุมมองที่เลือกได้
  • มุมมองที่เลือกได้: มุมมองที่เลือกได้พร้อมคุณสมบัติ foreground ก่อน API 23
  • มุมมองที่เลือกได้ AppCompat: มุมมองที่เลือกได้สำหรับ AppCompatTextView
  • มุมมองที่เลือกได้ข้อ จำกัด : มุมมองที่เลือกได้สำหรับข้อ จำกัด
• Typesafe Recyclerview: Typesafe ViewHolder และ ItemViewHolder เพื่อการใช้งานขั้นพื้นฐานง่ายๆของ RecyclerView

ผู้ช่วยออกแบบวัสดุ (Android เท่านั้น)

• สีวัสดุ: 2014 วัสดุการออกแบบวัสดุสีเป็นทรัพยากรสี
• รายการวัสดุ: รายการมุมมองรายการการใช้แนวทางการออกแบบวัสดุ (เหมาะสำหรับการใช้งานใน RecyclerView )

การสื่อสารระหว่างแอพระหว่างและข้าม: กิจกรรมชิ้นส่วนเจตนาและการรวมกลุ่ม

• กิจกรรม: เริ่มกิจกรรมด้วยแผ่นหม้อต้มน้อยที่สุด
• Intents: แปลง companion object เป็นรายละเอียดความตั้งใจที่มีประสิทธิภาพและสร้างวิธีที่ PendingIntent และง่าย
• แฟรกเมนต์: เริ่มกิจกรรมจากชิ้นส่วนและทำธุรกรรมด้วยแผ่นหม้อต้มน้อยที่สุด
• Fragment Args: ข้อโต้แย้งชิ้นส่วนที่ไม่มีพิธีขอบคุณคุณสมบัติที่ได้รับมอบหมาย
• Bundle: BundleSpec ใช้ Bundle ด้วยไวยากรณ์คุณสมบัติสำหรับ Intent พิเศษและอื่น ๆ

พร้อมกัน (multiplatform)

• Coroutines: ส่วนขยายวัตถุประสงค์ทั่วไปไปยัง kotlinx.coroutines
• Coroutines Lifecycle (Android เท่านั้น): การรวม Coroutines กับ Lifecycle Androidx
• เธรดหลัก: คุณสมบัติและหมากฮอสที่เกี่ยวข้องกับเธรดหลัก
• ตัวจัดการหลัก (Android เท่านั้น): คุณสมบัติ mainHandler ระดับบนสุดเพื่อหยุดการจัดสรร Handler หลายตัวสำหรับ Looper หลัก
• ตรวจสอบขี้เกียจ (Android เท่านั้น): mainThreadLazy ที่ตรวจสอบการเข้าถึงคุณสมบัติบน

การคงอยู่ของข้อมูล (multiplatform)

• การตั้งค่า: ไวยากรณ์คุณสมบัติสำหรับ SharedPreferences / DataStore ของ Android และ MacOS/iOS/WatchOS NSUserDefaults
• Arch Room: ผู้ช่วยห้องพักในการสร้างอินสแตนซ์ DB ของคุณและทำธุรกรรมใน Kotlin

สาธารณูปโภค (Multiplatform)

• ธงบิต: hasFlag , withFlag และ minusFlag ส่วนขยายใน Long , Int , Short , Byte และคู่ที่ไม่ได้ลงชื่อ
• คอลเลกชัน: forEach สำหรับ List s โดยไม่ต้องจัดสรร Iterator ซ้ำ

การดีบัก (Android เท่านั้น)

• Stetho Init: มี Stetho สำหรับการดีบักของคุณโดยไม่ต้องเขียนรหัสใด ๆ !

มรดก (Android เท่านั้น)

• ข้อยกเว้น: unexpectedValue(…) , unsupportedAction(…) และฟังก์ชั่นที่คล้ายกันที่ Nothing
• Arch Lifecycle: ส่วนขยายเพื่อรับ ViewModel S ใช้ LiveData และสังเกต Lifecycle

การดาวน์โหลด

คำแนะนำ Gradle

ตรวจสอบให้แน่ใจว่าคุณมี mavenCentral() ในที่เก็บที่กำหนดไว้ในไฟล์ build.gradle (รูท) ของโครงการของคุณ (ค่าเริ่มต้นสำหรับโครงการ Android Studio ใหม่)

เพื่อให้ง่ายต่อการใช้ประโยชน์จากเนื้อหาของ Splitties สำหรับโครงการ Android ของคุณมีการจัดกลุ่มสิ่งประดิษฐ์ที่รวมถึงการแยกส่วน ใหญ่

ฐาน Android

การเพิ่มด้วยการรีเฟรช: Splitties.pack.androidBase หรือ Splitties.pack.androidBaseWithViewsDsl

2 แพ็คเหล่านี้ไม่รวม AppCompat และเหมาะสำหรับแอพ Wearos

รวมโมดูลต่อไปนี้:

• กิจกรรม
• Appctx
• bitflags
• มัด
• ของสะสม
• coroutines
• ขนาด
• ชิ้นส่วน
• fragmentargs
• เจตนา
• Lifecycle-coroutines
• ผู้ขับขี่หลัก
• minthread
• สีวัสดุ
• การอนุญาต
• การตั้งค่า
• ทรัพยากร
• Systemservices
• ขนมปังปิ้ง
• มุมมอง
• Views-Coroutines
• วิวทิวทัศน์
• เลือกดูได้
• มุมมองที่เลือกได้-constraintlayout

การพึ่งพา Gradle:

implementation( " com.louiscad.splitties:splitties-fun-pack-android-base:3.0.0 " )

นอกจากนี้ยังมีเวอร์ชันที่มี Views DSL นอกจากนี้ยังรวมถึงโมดูลต่อไปนี้:

• views-dsl
• Views-dsl-constraintlayout
• Views-DSL-Recyclerview

การพึ่งพา Gradle:

implementation( " com.louiscad.splitties:splitties-fun-pack-android-base-with-views-dsl:3.0.0 " )

Android AppCompat

การเพิ่มด้วย refreshersions: Splitties.pack.appCompat หรือ Splitties.pack.appCompatWithViewsDsl

2 แพ็คเหล่านี้ประกอบด้วยแพ็คฐาน Android และโมดูลต่อไปนี้:

• ALERTDIALOG-AppCompat
• AlertDialog-AppCompat-Coroutines
• มุมมอง-การประนีประนอม
• มุมมองที่เลือกได้

การพึ่งพา Gradle:

implementation( " com.louiscad.splitties:splitties-fun-pack-android-appcompat:3.0.0 " )

นอกจากนี้ยังมีเวอร์ชันที่มี Views DSL นอกจากนี้ยังรวมถึง Views DSL เวอร์ชันของ Android Base Pack และโมดูลต่อไปนี้:

• Views-DSL-Appcam

การพึ่งพา Gradle:

implementation( " com.louiscad.splitties:splitties-fun-pack-android-appcompat-with-views-dsl:3.0.0 " )

ส่วนประกอบวัสดุ Android

การเพิ่มด้วยการรีเฟรช: Splitties.pack.androidMdc หรือ Splitties.pack.androidMdcWithViewsDsl

2 แพ็คเหล่านี้รวมถึง Android AppCompat Pack และโมดูลต่อไปนี้:

• การ alertdialog
• รายชื่อวัสดุ
• บาร์
• Views-Cardview
• views-coroutines-material
• วัตถุดิบ

การพึ่งพา Gradle:

implementation( " com.louiscad.splitties:splitties-fun-pack-android-material-components:3.0.0 " )

นอกจากนี้ยังมีเวอร์ชันที่มี Views DSL นอกจากนี้ยังรวมถึง Views DSL เวอร์ชันของ Android AppCompat Pack และโมดูลต่อไปนี้:

• Views-dsl-coordinatorlayout
• views-dsl-material

การพึ่งพา Gradle:

implementation( " com.louiscad.splitties:splitties-fun-pack-android-material-components-with-views-dsl:3.0.0 " )

สิ่งประดิษฐ์ทั้งหมด (47)

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

วิธีที่ดีที่สุดในการทำเช่นนี้คือการใช้การรีเฟรชมีสัญลักษณ์การพึ่งพาในตัวสำหรับ Splitties และห้องสมุดที่เป็นที่นิยมและคุณภาพอื่น ๆ อีกมากมายเช่น Kotlinx, Androidx, ห้องสมุดจาก Square/CashApp และ Libraries จาก Google

สิ่งสำคัญที่สุดคือการใช้งาน refreshVersions จะแสดงการอัปเดตที่มีอยู่ในเวลาไม่กี่วินาทีสำหรับการพึ่งพาทั้งหมดของคุณใน versions.properties ของคุณ

FYI การเปิดตัวล่าสุดของ Splitties ล่าสุดคือเวอร์ชัน 3.0.0

นี่คือพิกัด Maven ของสิ่งประดิษฐ์ทั้งหมดของห้องสมุดนี้สำหรับการอ้างอิง (คลิกเพื่อขยาย)

 com.louiscad.splitties:splitties-activities
com.louiscad.splitties:splitties-alertdialog
com.louiscad.splitties:splitties-alertdialog-appcompat
com.louiscad.splitties:splitties-alertdialog-appcompat-coroutines
com.louiscad.splitties:splitties-appctx
com.louiscad.splitties:splitties-arch-lifecycle
com.louiscad.splitties:splitties-arch-room
com.louiscad.splitties:splitties-bitflags
com.louiscad.splitties:splitties-bundle
com.louiscad.splitties:splitties-checkedlazy
com.louiscad.splitties:splitties-collections
com.louiscad.splitties:splitties-coroutines
com.louiscad.splitties:splitties-dimensions
com.louiscad.splitties:splitties-exceptions
com.louiscad.splitties:splitties-fragments
com.louiscad.splitties:splitties-fragmentargs
com.louiscad.splitties:splitties-intents
com.louiscad.splitties:splitties-lifecycle-coroutines
com.louiscad.splitties:splitties-mainhandler
com.louiscad.splitties:splitties-mainthread
com.louiscad.splitties:splitties-material-colors
com.louiscad.splitties:splitties-material-lists
com.louiscad.splitties:splitties-permissions
com.louiscad.splitties:splitties-preferences
com.louiscad.splitties:splitties-resources
com.louiscad.splitties:splitties-snackbar
com.louiscad.splitties:splitties-stetho-init
com.louiscad.splitties:splitties-systemservices
com.louiscad.splitties:splitties-toast
com.louiscad.splitties:splitties-typesaferecyclerview
com.louiscad.splitties:splitties-views
com.louiscad.splitties:splitties-views-appcompat
com.louiscad.splitties:splitties-views-cardview
com.louiscad.splitties:splitties-views-coroutines
com.louiscad.splitties:splitties-views-coroutines-material
com.louiscad.splitties:splitties-views-dsl
com.louiscad.splitties:splitties-views-dsl-appcompat
com.louiscad.splitties:splitties-views-dsl-constraintlayout
com.louiscad.splitties:splitties-views-dsl-coordinatorlayout
com.louiscad.splitties:splitties-views-dsl-ide-preview
com.louiscad.splitties:splitties-views-dsl-material
com.louiscad.splitties:splitties-views-dsl-recyclerview
com.louiscad.splitties:splitties-views-material
com.louiscad.splitties:splitties-views-recyclerview
com.louiscad.splitties:splitties-views-selectable
com.louiscad.splitties:splitties-views-selectable-appcompat
com.louiscad.splitties:splitties-views-selectable-constraintlayout

ภาพรวม

สมมติว่าคุณต้องลองใช้คุณสมบัติใหม่หรือการแก้ไขที่ยังไม่ได้เปิดตัว:

คุณสามารถคว้าได้ในเวอร์ชัน Snapshot โดยการเพิ่มที่เก็บข้อมูลที่สอดคล้องกันดังที่แสดงด้านล่างและเปลี่ยนเวอร์ชันไลบรารีเป็น snapshot ล่าสุด 3.0.0-SNAPSHOT :

allProjects {
    repositories {
        mavenCentral()
        google() // Add sonatype snapshots repo below
        maven(url = " https://oss.sonatype.org/content/repositories/snapshots " )
    }
}

การแจ้งเตือนเวอร์ชันใหม่

มีการประกาศการเปิดตัวใน GitHub คุณสามารถสมัครสมาชิกได้โดยคลิกที่ "ดู" จากนั้น "ปล่อยเท่านั้น"

อย่างไรก็ตามหากคุณใช้ Refreshersions คุณจะได้เรียนรู้เกี่ยวกับการอัปเดตเมื่อคุณรันงาน refreshVersions ในไฟล์ versions.properties

ปรับปรุงห้องสมุดนี้

หากคุณต้องการให้ห้องสมุดนี้มี คุณสมบัติใหม่หรือการปรับปรุง ในโมดูลใหม่หรือในโมดูลที่มีอยู่โปรดเปิดปัญหาหรือโหวต/แสดงความคิดเห็นที่คล้ายกันก่อนดังนั้นจึงสามารถพูดคุยได้

นอกจากนี้ยังยินดีต้อนรับ การมีส่วนร่วมของเอกสาร สำหรับการพิมพ์ผิดหรือการปรับปรุงเล็ก ๆ น้อย ๆ อื่น ๆ อย่าลังเลที่จะส่ง PR (คำขอดึง) โดยตรง สำหรับการบริจาคเอกสารที่สำคัญยิ่งขึ้นโปรดเปิดปัญหาก่อนดังนั้นจึงสามารถพูดคุยได้

หากคุณพบข้อผิดพลาด โปรดเปิดปัญหาพร้อมรายละเอียดที่สำคัญทั้งหมด หากคุณรู้ว่าการแก้ไขอย่างง่ายที่ไม่ใช่การทำลาย API และไม่มีผลข้างเคียงที่ต้องพิจารณาคุณอาจส่ง PR โดยตรง

นอกจากนี้คุณยังสามารถเข้าร่วมการอภิปรายเกี่ยวกับ Slack ของ Kotlin ในช่อง #splitties (คุณสามารถรับคำเชิญได้ที่นี่)

การแยกคืออะไร

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

สมมติว่าคุณกำลังสร้างแอพ Wear OS โดยใช้ Views DSL สวมแอพ OS ไม่จำเป็นต้องใช้ AppCompat รวมถึงมันจะเป็นการสิ้นเปลืองแบนด์วิดท์และการจัดเก็บ มุมมอง DSL Core Module ขึ้นอยู่กับ Android SDK แต่ไม่ได้อยู่ใน AppCompat ดังนั้นคุณจะไม่ขยายแอพข้อมือของคุณด้วย AppCompat โดยใช้ Views DSL อย่างไรก็ตามหากคุณกำลังสร้างแอพโทรศัพท์แท็บเล็ตหรือคอมพิวเตอร์ Android จะมีการดู DSL AppCompat ที่แยกด้วยส่วนขยายสองสามตัวเพื่อให้คุณใช้

การให้เครดิต

ขอขอบคุณเป็นพิเศษกับ Jovche Mitrejchevski ที่ช่วยในการตัดสินใจสำหรับโครงการนี้

ต้องขอบคุณ Jetbrains และผู้มีส่วนร่วมของ Anko ซึ่งเป็นแหล่งแรงบันดาลใจที่ยอดเยี่ยมโดยเฉพาะอย่างยิ่งสำหรับมุมมอง DSL และแน่นอนขอบคุณสำหรับภาษาการเขียนโปรแกรม Kotlin ที่ยอดเยี่ยมที่ทำให้โครงการนี้เป็นไปได้

ขอบคุณ Doug Stevenson สำหรับบทความของเขา "Kotlin & Android: การทดลองทองเหลือง tacks" มันยุติธรรมที่จะบอกว่ามุมมอง DSL มีรากในการทดลองนี้

ใบอนุญาต

ไลบรารีนี้เผยแพร่ภายใต้ Apache License Version 2.0 ซึ่งคุณสามารถดูได้ที่นี่