Eine Sammlung von Best Practices für Applikationen mit AngularJS. Der Vortrag stellt Strukturen und Konventionen vor, mit denen sich auch umfangreiche Applikationen wartbar und erweiterbar halten lassen.

1. Große Applikationen
mit

2. WHO AM I?
• Sebastian Springer
• aus München
• arbeite bei Mayflower
• https://github.com/sspringer82
• @basti_springer
• Consultant,Trainer,Autor

3. Konventionen
Wenn ihr heute nur einen Punkt mitnehmt, dann:
Haltet euren Code und eure Struktur einheitlich.

4. Was ist eine
große Applikation?
K. Bangwa / pixelio.de

5. Großer
Funktionsumfang

6. Grundsätzliches
Bernd Kasper / pixelio.de

7. Sprechender Code

8. Sprechender Code
angular.module('myApp', [])
.controller('MyCtrl', MyCtrl);
function MyCtrl() {
var vm = this;
vm.onSaveButtonClicked = onSaveButtonClicked;
function onSaveButtonClicked() {}
}

9. Sprechender Code
Was ist, wenn ein Funktionsname zu lange wird?
Dann macht die Funktion wahrscheinlich zu viel und sollte
aufgeteilt werden.

10. Komplexität
Tim Reckmann / pixelio.de

11. Komplexität
Applikation in kleinere, weniger komplexe Einheiten unter-
teilen und diese zu einem Komplettsystem integrieren.

12. Komplexität
vm.start = function() {
vm.status = "started";
stopInterval = $interval(function () {
var data = readerDataFactory.getPart();
if (data) {
vm.part = data;
} else {
vm.part = "";
vm.status = "stopped";
$interval.cancel(stopInterval);
stopInterval = null;
vm.text = readerDataFactory.getText();
}
}, 1000 * 60 / readerDataFactory.getWPM());
};
vm.stop = function() {
vm.status = "stopped";
$interval.cancel(stopInterval);
stopInterval = null;
};

13. Styleguide

14. Styleguide
Der Quellcode soll überall gleich aussehen.
Dem Quellcode soll man nicht ansehen, wann er von wem mit
welcher Laune geschrieben wurde.
Ein guter Start ist: https://github.com/johnpapa/angular-
styleguide

15. Werkzeuge
Gila Hanssen / pixelio.de

16. Entwicklungsumgebung

17. Entwicklungsumgebung
Autocompletion: Variablen und Konstrukte vervollständigen.
Hilfestellung bieten.
Highlighting: Visuelle Abgrenzung zwischen verschiedenen
Konstrukten für erhöhte Lesbarkeit.
Linting: Anti-Pattern-Erkennung, um Fehler zu vermeiden.
Angular Plugins für WebStorm, Eclipse,…

18. Entwicklungsumgebung

19. Paketverwaltung
Rainer Sturm / pixelio.de

20. Paketverwaltung
Installation externer Bibliotheken. Versionsverwaltung und
Überblick über installierte Bibliotheken. Auflösung von
Abhängigkeiten.
Paketmanager: bower, npm, spmjs,…

21. Paketverwaltung
$ bower install angular
bower angular#* cached git://github.com/angular/bower-a
bower angular#* validate 1.4.0 against git://github.com/a
bower angular#~1.4.0 install angular#1.4.0
angular#1.4.0 bower_components/angular

23. Yeoman
Scaffolding für Webprojekte. Bietet Generatoren, um schnell
häufig benötigte Strukturen im Projekt zu schaffen.

24. Yeoman
npm install -g yo
npm install -g generator-angular
yo angular myApp
yo angular:controller account

25. Yeoman
Problem:
Aber unsere Applikation ist etwas ganz besonderes und die
bestehenden Generatoren passen für uns nicht. Wir müssen
jede Struktur nochmal anfassen und umbauen.
Lösung:
Eigene Generatoren erstellen.
Guide: http://yeoman.io/authoring/

26. Struktur
Initiative Echte Soziale Marktwirtschaft IESM / pixelio.de

27. Struktur
Wie baut man eine Applikation auf, damit sie wartbar und
erweiterbar bleibt?
Wo findet man bestimmte Komponenten?
Wie werden die Verzeichnisse strukturiert?
Wie heißen die Dateien?

28. Ein Verzeichnis pro
Feature

29. Ein Verzeichnis pro Feature
Features unabhängig halten. Wiederverwendbarkeit in
anderen Applikationen erreichen. Klares Namespacing
einführen.

30. Ein Verzeichnis für
shared content

31. Ein Verzeichnis für shared
content
Gemeinsam genutzte Komponenten liegen in einer eigenen
Hierarchie. Abhängigkeiten zwischen Modulen werden
vermieden.

32. Eine Komponente pro
Datei

33. Eine Komponente pro Datei
Controller, Services, Direktiven, … erhalten jeweils ihre eigene
Datei.
Single Responsibility - eine Datei ist nur für einen Zweck da.
Zuordnung von Zuständigkeiten ist einfach. Das Auffinden
von Quellcode ist schneller.

34. Eine Komponente pro Datei
angular.module('user.controller.login', [])
.controller('user.loginController', LoginController);
function LoginController() {
}

35. Einheitliche sprechende
Benennung

36. Einheitliche sprechende
Benennung
Die Namen von Dateien und deren Speicherort folgt einem
konsistenten Schema.
Das Lokalisieren von Komponenten wird einfacher.
/user/login.controller.js

37. Konfiguration
auslagern

38. Konfiguration auslagern
Die Konfiguration eines Moduls liegt in einer eigenen Datei
innerhalb des Moduls.
Die Konfiguration erfolgt an einer zentralen Stelle und nicht
über die Komponenten verteilt.

39. Konfiguration auslagern
angular.module('addressBook.translation', ['pascalprecht.translate'])
.config(['$translateProvider', function ($translateProvider) {
$translateProvider.translations('de', de);
$translateProvider.translations('en', en);
$translateProvider.preferredLanguage('en');
}]);

40. Struktur flach halten

41. Struktur flach halten
Die Verzeichnisstruktur sollte initial möglichst flach sein. Bei
Bedarf (viele Dateien pro Verzeichnis) tiefer werden.

42. Routing
Erich Westendarp / pixelio.de

43. Routing
Navigation zwischen verschiedenen States in der
Applikation.
States arbeiten mit Views, die benannt sein können. Optional
können Controller hinzugefügt werden.
Implementierungen:
- ngRoute
- angular-ui-router

44. Routing - Konfiguration
angular.module('adress', ['ui.router'])
.config(ConfigFn);
ConfigFn.$inject = ['$stateProvider', '$urlRouterProvider'];
function ConfigFn ($stateProvider, $urlRouterProvider) {
$urlRouterProvider.otherwise('/list');
$stateProvider.state('list', {
url: '/list',
template: tplList,
controller: 'listCtrl'
});
}

45. Routing - advanced
Mehrere benannte Views
<body>
<div ui-view="content"></div>
<div ui-view="info"></div>
</body>
$stateProvider.state('list', {
url: '/list',
views: {
content: {
template: tplListContent,
controller: 'listContentCtrl'
},
info: {
template: tplListInfo,
controller: 'listInfoCtrl'
}
}

46. Routing - advanced
<div ui-view></div>
<a ui-sref="state1">State 1</a>
<a ui-sref="state1.list">Show List</a>
<div ui-view></div>
index.html
state1.html
state1.list.html
<ul>
<li ng-repeat="item in items">{{ item }}</li>
</ul>
Nested Views

47. Routing - advanced
Nested Views
$stateProvider
.state('state1', {
url: "/state1",
templateUrl: "partials/state1.html"
})
.state('state1.list', {
url: "/list",
templateUrl: "partials/state1.list.html",
controller: function($scope) {
$scope.items = ["A", "List", "Of", "Items"];
}
});

48. Routing - new Router
Redesignter Router. Folgeversion von ngRoute. Aktuell noch
nicht stabil. Ist aber für 1.4 und 2 vorgesehen.

49. DRY
Don’t Repeat Yourself

50. DRY
Sobald eine Routine zum zweiten Mal implementiert wird,
sollte sie in einen eigenständigen Service ausgelagert
werden.
Diese Services können abstrahiert und durch
unterschiedliche Konfiguration an mehreren Stellen
wiederverwendet werden.

51. DRY
Nützliche Helper können in einer eigenen Library gesammelt
werden.
z.B. Logger

52. NIH
Not Invented Here

53. NIH
Bevor man etwas selbst implementiert, sollte man zuerst
prüfen, ob es für diese Problemstellung nicht schon eine
Lösung gibt.
Beispiele:
- REST-Kommunikation: ngResource, restangular
- Websocket: angular-websocket, ng-websocket
- localstorage: angular-local-storage
- Routing: ngRoute, ui-router
- Translation: ngTranslate

54. Dokumentation
René Golembewski / pixelio.de

55. Dokumentation
Es muss nicht jede Funktion dokumentiert werden (z.B.
Callbacks)
Lieber sprechenden Code schreiben.

56. Dokumentation
Schnittstellen zwischen Teams/Projekten müssen
dokumentiert und AKTUELL gehalten werden.

57. Dokumentation
Angular selbst verwendet jsdoc bzw. ngdoc und Dgeni zum
Parsen.
Weitere Infos:
https://github.com/angular/angular.js/wiki/Writing-AngularJS-
Documentation

58. Dokumentation
/**
* @name trim
* @private
*
* @description
* trim polyfill
*
* @returns {string} The string stripped of whitespace from both ends
*/
var trim = function() {
return this.toString().replace(/^s+|s+$/g, '');
};

60. Typescript
Zur Dokumentation von Schnittstellen kann zusätzlich
Typescript eingesetzt werden.
Möglichkeit zur Beschreibung von Signaturen, Klassen und
Interfaces.

61. Code
Corinna Dumat / pixelio.de

62. Struktur vs.
Implementierung

63. Struktur vs. Implementierung
Trennung der konkreten Implementierung und der Struktur.
Rückgabe/Bindables getrennt von den
Funktionsdefinitionen.

64. Struktur vs. Implementierung
function ListCtrl() {
var vm = this;
vm.onEdit = onEdit;
vm.onDelete = onDelete;
function onEdit(id) {…}
function onDelete(id) {…}
}
function ItemService() {
return {
fetch: fetch,
save: save
};
function fetch() {...}
function save() {...}
}
Controller:
Factory:

65. init-Funktion

66. init-Funktion
Sämtliche Logik, die in einem Controller zur Initialisierung
direkt ausgeführt wird, wird in einer Funktion gekapselt.
So sieht man auf einen Blick, was passiert, wenn dieser
Controller erstellt wird.

67. init-Funktion
function ListCtrl(itemStore) {
var vm = this;
vm.items = [];
function init() {
itemStore.fetch().then(function(items) {
vm.items = items;
});
}
init();
}

68. Logik in Services

69. Logik in Services
Controller sollten nicht zu viel Logik beinhalten, da sie
dadurch unleserlich werden. Umfangreichere Logik in
Services auslagern.

70. Ein Controller pro View

71. Ein Controller pro View
Mehrere Views sollten sich nicht einen Controller teilen. Dies
macht es meistens erforderlich, Logikweichen einzubauen,
die die Lesbarkeit beeinträchtigen.

72. Promises
JMG / pixelio.de

73. Promises
Promises sind ein Mittel, um asynchronen Programmfluss zu
steuern. Sie erhöhen die Lesbarkeit des Quellcodes und
helfen bei der Fehlerbehandlung.

74. Promises
ListCtrl.$inject = ['$q', '$timeout'];
function ListCtrl($q, $timeout) {
function async() {
return $q(function (resolve, reject) {
$timeout(function () {
resolve('Hello');
}, 1000);
});
}
async().then(function (data) {
vm.data = data;
});
}

75. Testing?
Rike / pixelio.de

76. Tests
Mindestens zwei Ebenen von Tests: Unittests und End2End-
Tests.
Manuelle Tests können allerdings nicht entfallen, da immer
noch irgendwo Logikfehler versteckt sein können.

77. Unittests

78. Unittests
Karma: bietet die Infrastruktur. Steuerung der
angeschlossenen Browser. Verteilung der Tests und
Einsammeln der Daten.
Jasmine: Formulieren der Tests.
Die Tests liegen bei den Dateien, die sie testen sollen. Tests
werden schneller gefunden und besser gepflegt, sind
gegenwärtiger.

79. describe('simple controller', function() {
var $rootScope, $scope, createController;
beforeEach(module('simpleCtrl'));
beforeEach(inject(function($injector) {
$rootScope = $injector.get('$rootScope');
$scope = $rootScope.$new();
var $controller = $injector.get('$controller');
createController = function() {
return $controller('PasswordCtrl', {
'$scope': $scope
});
};
}));
it('should have a name property with a value', function() {
var controller = createController();
expect($scope.name).toBe('Hans-Peter');
});
it('should execute a function', function() {
var controller = createController();
expect($scope.myFunc()).toBe('hello');
})
});

80. End2End

81. End2End
Werden mit Protractor erstellt. Bauen auf Selenium
WebDriver auf. Testen die komplette Applikation inklusive
Server.
Längere Laufzeit als Unittests. Testen Integration einzelner
Komponenten in die Applikation.
Werden in einer parallelen Verzeichnishierarchie gepflegt.

82. End2End
describe('project list', function() {
it('should check the first item in the list', function(done) {
browser.get('/');
var name = element(by.repeater('project in projects')
.row(0)
.column('name'));
expect(name.getText()).toEqual('Projekt A');
done();
});
});

83. Test Doubles
Regina Kaute / pixelio.de

84. Test Doubles
Test Doubles für Services verwenden, z.B. $httpBackend.
Für alles Übrige kommt Sinon.js zum Einsatz.

85. Module Loader
Bernd Kasper / pixelio.de

86. Module Loader
Keine Script-Tags mehr schreiben. Abhängigkeiten zwischen
Dateien werden aufgelöst. Können im Build zu einer Datei
zusammengefasst werden.
Beispiele:
- require.js
- Browserify
- SystemJS
- …

87. Module Loader
define(['angular'], function(angular) {
var controller = angular.module('controller', [])
.controller('ListCtrl', ListCtrl);
function ListCtrl() {…}
return controller;
});

88. Statische
Codeanalyse
Tim Reckmann / pixelio.de

89. Statische Codeanalyse
Statische Prüfung des Quellcodes. Auffinden von
Antipatterns oder Betrachtung bestimmter Metriken wie z.B.
Komplexität.
Tools:
- linter (jslint, jshint, eslint)
- Plato

90. Statische Codeanalyse

91. Buildsysteme
schau media / pixelio.de

92. Buildsysteme
Automatisieren von wiederkehrenden Aufgaben wie Tests,
Build, Linting
Beispiele:
- grunt
- gulp
- npm

93. Buildsysteme
module.exports = function(grunt) {
grunt.initConfig({
copy: {...},
clean: {
bower: ['bower_components']
},
shell: {
bower: {
command: 'bower install'
}
},
watch: {
scripts: {
files: ['src/**/*.js', 'src/**/*.html'],
tasks: ['copy:app']
}
},
requirejs: {...}
});
require('load-grunt-tasks')(grunt);
grunt.registerTask('bower', ['shell:bower', 'copy:bower',
'clean:bower']);
};

94. Kommunikation
Aka / pixelio.de

95. Kommunikation
Wie werden Daten zwischen einzelnen Komponenten einer
Applikation ausgetauscht?

96. Kommunikation
innerhalb der Applikation

97. Services
Services sind Singletons und können an verschiedenen
Stellen verwendet werden.
Mit Services lassen sich Nachrichtenbusse umsetzen, die zur
Kommunikation zwischen den Komponenten verwendet
werden können.

98. angular.module('myApp', [])
.factory('MsgBus', MsgBus);
function MsgBus() {
var callbacks = {};
return {
on: on,
trigger: trigger
};
function on(event, callback) {
if (callbacks[event]) {
callbacks[event] = [callback];
return this;
}
callbacks[event].push(callback);
}
function trigger(event, data) {
if (callbacks[event]) {
callbacks[event].forEach(function (callback) {
callback(data);
});
}
}
}

99. Direktiven
Direktiven sind Marker im HTML, die den Funktionsumfang
von HTML erweitern.
Mithilfe der Scope-Eigenschaft der Direktive kann zwischen
dem außenliegenden Controller und der Direktive
kommuniziert werden.

100. Direktiven
<my-directive name="{{ name }}" color="color" reverse="reverseName()">
angular.module('app', [])
.directive('myDirective', myDirective);
function myDirective() {
return {
scope: {
name: '@', // one way (read only)
color: '=', // two way
reverse: '&' // function binding
}
}
}

101. Kommunikation zum
Server

102. Kommunikation zum Server
Services, die die Kommunikation kapseln.
$http, restangular, ngResource, angular-websocket
Abstrahieren die Schnittstelle zum Server. Können zum
Testen durch Stubs ersetzt werden.

103. Kommunikation zum Server
$http.get('/weather').success(function (data) {
data.forEach(function (item) {
if (item.id === id) {
vm.data = item;
}
});
});

104. Performance
Thomas Siepmann / pixelio.de

105. Performance
Angular ist ein Framework, das bedeutet Overhead.
Two Way Data-Binding mit Dirty Checking ist eines der
größten Performance-Probleme.
Mögliche Lösung: angular-vs-repeat, ngGrid

106. Performance

107. Performance
Bei tiefergehenden Performance-Problemen: Developer Tools
nutzen und die Applikation auseinander nehmen.

108. Fragen?
Rainer Sturm / pixelio.de

109. KONTAKT
Sebastian Springer
sebastian.springer@mayflower.de
Mayflower GmbH
Mannhardtstr. 6
80538 München
Deutschland
@basti_springer
https://github.com/sspringer82