android base

Android -Basis

Einführung

Diese Projekte zielen darauf ab:

• Ein Beispiel für mobile Client -Apps, um über native Android -Setup und -entwicklung zu diskutieren.
• Eine grundlegende Vorlage, um Projekte daraus zu starten.

Spezifikationszusammenfassung:

• App -Kesselplatte (Benutzer, Einstellungen, Info ...)
• Notizen -App -Beispiel.
• MVP Clean Architecture.
• Abhängigkeitsinversion (Dolch 2 und Butterknife).
• Reaktive Programmierung (Rxjava und Rxandroid).
• RESTful -Client mit Version, Sprache und Authentifizierung (Nachrüstung).
• Abdeckung der vollständigen Einheitstests (Espresso, Mockito und Dolch 2).
• Andere Muster und gute Praktiken.
• Kontinuierliches Integrationssystem.
• Skripte zum Zurücksetzen des Projekts.

Hier ist die API der Gegenstücksserver-API, von der diese App die Daten konsumiert-> Rails-API-Base

Schneller Start

• Installieren Sie Ihre Lieblings -IDE oder nur die Android SDK (Buildtools 23.0.2 und CompilesDK 23, oder definieren Sie Ihre eigenen Versionen in den dependencies.gradle ). Ich benutze Android Studio.

• Klonen Sie das Repository und gehen Sie hinein:

 git clone git://github.com/jordifierro/android-base.git --origin android-base YourProjectName
cd YourProjectName

• Entfernen Sie den damit verbundenen Code (optional) alle 'Notiz':

 ./bin/remove_notes

• Benennen Sie den Projekt- und Paketnamen um:

 ./bin/rename_project YourProjectName your.package.name

• Schließen Sie ein Gerät an (oder starten Sie den Emulator) und führen Sie die Tests aus:

 ./gradlew clean build cAT

• Sobald der Build erfolgreich ist, erstellen Sie ein neues Remote -Repository und führen Sie diese dann aus, um das Repo zurückzusetzen und zu schieben:

 ./bin/reset_git https://github.com/yourusername/YourProjectName.git

Das war's, Sie können jetzt beginnen, Ihre eigene App zu entwickeln!

HINWEIS: Um die App auszuführen (Sie können jetzt nur die Tests ausführen) denken Sie daran, einen API-Server einzurichten (Rails-API-Base wurde bereits für diese App entwickelt. Sie können jedoch auch Ihre eigenen erstellen) und die RestApi so konfigurieren, dass sie eine Verbindung zu ihm herstellen (einfach restAPI.java-Params ändern).

Dokumentation

Die Anwendung selbst ist nahezu leer, zielt nur darauf ab, einige grundlegende Module bereitzustellen, die Strukturen mit einigen Mustern zu implementieren und Beispielcode anzugeben. Hier sind die Spezifikationen:

App -Kesselplatte

Das Hauptziel dieser Anwendung besteht darin, das Schreiben von App -Basic -Boilerplate -Code zu vermeiden. Daher sind bereits folgende Funktionen implementiert:

• Benutzeranmeldung
• Benutzerregister
• Benutzerkennwortwiederherstellung
• Einstellungsbildschirm mit Abmelden, Konto löschen und Informationslinks
• Allgemeine Bedingungen Bildschirm
• Datenschutzrichtlinie Bildschirm
• Sitzung Persistenz
• Navigation
• Ruhestand
• App -Architektur -Skelett
• Mehrere Testbeispiele

Dies kann ab jetzt verwendet werden und bietet auch eine strukturierte Möglichkeit, mehr Code hinzuzufügen.

Notizen Beispielcode

Um mehr Beispielcode bereitzustellen, wurde Code entwickelt, um notes zu verwalten ( title content Somit hat die App Notizenindex, Details, Erstellen und Bearbeiten von Bildschirmen.

Sein einzigartiger Zweck ist es, ein Beispielcode zu sein, sodass er beim Ausführen gelöscht wird ./bin/remove_notes -Skript.

MVP Clean Architecture

Der Code wurde nach dem Clean Architecture-Ansatz und dem MVP-Muster (Model-View-Presenter) strukturiert. Überprüfen Sie dies und diese Beiträge und auch dieses Projekt, um weitere Informationen dazu zu erhalten.

Abhängigkeitsinversionsprinzip

Das Abhängigkeitsinversionsprinzip wird in der App im Grunde genommen einfacher verwendet, um Tests zu erleichtern und die Komponenten entkoppelt und wiederverwendbar zu machen. Es reduziert auch den Code des Boilerplate und hilft bei der Verwaltung der Instanzbereiche. Die Bibliothek, mit der dies erreicht wird, ist Dolch 2. Butterknife wird zur Ansichtsinjektion verwendet.

Reaktive Programmierung

Durch Clean Architecture werden Sie verschiedene Schichten erstellen, und um ein Rückrufhölle zu vermeiden, wird reaktives Programmierparadigma mithilfe der Reactivex -Bibliothek angewendet.

RESTful -Client mit Version, Sprache und Authentifizierung

Als Client -App ist das Hauptziel, dass der Benutzer mit Daten einer Server -API interagieren. Das Projekt zeigt, wie man so einfach damit umgeht. Die Nachrüstbibliothek wird verwendet, um die API -Aufrufmethoden zu implementieren. Authentifizierung, API -Version und Internationalisierung sind in den Anfragen enthalten.

Abdeckung der vollständigen Einheitstests

Eines der interessantesten Dinge dieses Projekts ist, dass es eine vollständige Abdeckung der Unit -Tests hat, von Datenmodulen bis hin zu Android -Ansichten, einschließlich aller Zwischenschichten. Dies ist das Ergebnis der Verwendung von sauberer Architektur, Abhängigkeitsinversion und guten Testpraktiken. Ein Beispiel dafür ist die Ansichtsprüfung, bei der der Ansichtspunkter von Mockito verspottet und durch Testen der Dolchkomponente injiziert wird, die von einem benutzerdefinierten Junit -Läufer bereitgestellt wird.

Hier finden Sie Tutorials, die einige dieser Tests erklären:

• Einheitstests anzeigen
• HTTPInterceptor -Test

Muster und gute Praktiken

Ein weiteres Muster und gute Praktiken werden im Projekt verwendet, wie z. B. implementieren Aktivitäten und Fragmente gemeinsames Verhalten mit Vererbung, verwenden Fragmente und definieren die Navigation in den Aktivitäten, um die Bildschirmumgestaltung schmerzlos zu machen, Schnittstellen zu verwenden, um Komponenten zu entkoppeln. Hier eine der verwendeten Ressourcen -> Android Best Practices.

Kontinuierliches Integrationssystem

Travis-Ci wurde als kontinuierliches Integrationssystem hinzugefügt, um den gesamten Test für jeden Push (sowohl Java- als auch Android-Tests) durchzuführen.

Um die Tests lokal auszuführen, schließen Sie einfach ein Gerät an oder führen Sie den Emulator aus und führen Sie aus:

 ./gradlew clean build cAT

Das wird sowohl Java- als auch Android -Tests durchführen.

Skripte zum Zurücksetzen des Projekts

Es gibt einige Skripte im Ordner /bin -Ordner, damit ein neues Projekt mit dieser Vorlage von Grund auf neu gestartet wird. Befolgen Sie einfach den oben platzierten Abschnitt "Schnellstart".

Alle Shell -Skripte werden vom Shellcheck -Tool verifiziert.

TODO -Liste

• Fügen Sie Probenintegrationstests hinzu.

Hier ist die API der Gegenstücksserver, von der diese App die Daten-> Rails-API-Base konsumiert.

Beitragen

Alle Vorschläge und Beiträge sind mehr als willkommen!

• Fork dieses Repo.
• Erstellen Sie Ihre Funktionszweig (Git Checkout -B -Funktionsname).
• Entwickeln Sie Ihre Funktion und testen Sie es.
• Tests erfolgreich ausführen:

 ./gradlew clean build cAT

• Bestimmen Sie Ihre Änderungen (Git Commit -m 'Implementieren Sie neue Funktionen').
• Drücken Sie die Änderungen (Git-Push-Ursprungs-Feature-Namen).
• Erstellen Sie eine Pull -Anfrage und ich werde sie mit dem Projekt zusammenführen.

Mitwirkende

Leider gibt es noch keine Mitwirkenden.

---

http://jordifierro.com