NgModulesのドキュメント読む

angular

前回のスタイルガイドに続き、ドキュメント読んで気になる箇所を抜粋。

NgModules

Angular modularity

  • @NgModuleのmetadata
    • components, directives, pipesの宣言
    • 必要ならば、宣言したものをpublicにする (他のモジュールのテンプレートで利用可能になる)
    • 自身で必要な他のモジュールをインポートする
    • servicesを提供し、どのコンポーネントでも利用可能する
  • モジュールクラスは必ず1つある (root module)

The root AppModule

Bootstrapping in main.ts

Declare directives and components

Service providers

Modules are a great way to provide services for all of the module’s components.

The Dependency Injection page describes the Angular hierarchical dependency-injection system and how to configure that system with providers at different levels of the application’s component tree.

（Dependency Injectionも後で読む）

  • モジュールはアプリケーションのroot dependency injectorにprovidersを追加し、servicesをアプリケーションのどこからでも利用可能にする

Import supporting modules

  • BrowserModuleをimportするとCommonModuleもimportされる
  • CommonModuleはngIf, ngForなどを宣言している

Application-scoped providers

  • serviceをmoduleに登録すると application-scoped になる (どこからでもinjectできるようになる)
  • アーキテクチャ的にはContactServiceは他のドメインで利用することはないので、injectできないようにしたい
  • Angularは意図的に module-scoping mechanism を提供していない

Read more in the How do I restrict service scope to a module? section of the NgModule FAQs page.

Resolve directive conflicts

Feature modules

  • モジュールは他のモジュールで宣言されているcomponents, directives, またはpipesへのアクセスを継承しない

Lazy-loading modules with the router

src/app/app-routing.module.ts

export const routes: Routes = [
  { path: '', redirectTo: 'contact', pathMatch: 'full'},
  { path: 'crisis', loadChildren: 'app/crisis/crisis.module#CrisisModule' },
  { path: 'heroes', loadChildren: 'app/hero/hero.module#HeroModule' }
];
  • routerについてはRouting & Navigation
  • cotact routeは Contact featureのrouting moduleで設定
  • routerによりContactComponentに遷移する場合、publicにする必要はない (exportする必要はない)
    • ContactComponentはselectorも必要としない

Shared modules

src/app/src/app/shared/shared.module.ts

@NgModule({
  imports:      [ CommonModule ],
  declarations: [ AwesomePipe, HighlightDirective ],
  exports:      [ AwesomePipe, HighlightDirective,
  
    // re-exports the CommonModule and FormsModule
    CommonModule, FormsModule ]
})
  • SharedModuleをimportすればCommonModule, FormsModuleもimportされるようになる
    • CommonModuleがimportされているのは、SharedModuleが必要としているから

Do not specify app-wide singleton providers in a shared module. A lazy-loaded module that imports that shared module makes its own copy of the service.

The Core module

  • CoreModuleは一度だけimportされる
    • AppRoot moduleがimportする

Cleanup

Configure core services with CoreModule.forRoot

  • 慣例で、forRootのstatic methodはserviceの提供と設定を同時に実行する
    • serviceの設定オブジェクトを受け取り、ModuleWithProvidersを返す

More precisely, Angular accumulates all imported providers before appending the items listed in @NgModule.providers. This sequence ensures that whatever you add explicitly to the AppModule providers takes precedence over the providers of imported modules.

src/app/core/user.service.ts (constructor)

constructor(@Optional() config: UserServiceConfig) {
  if (config) { this._userName = config.userName; }
}

src/app/core/core.module.ts (forRoot)

static forRoot(config: UserServiceConfig): ModuleWithProviders {
  return {
    ngModule: CoreModule,
    providers: [
      {provide: UserServiceConfig, useValue: config }
    ]
  };
}

src/app//app.module.ts (imports)

imports: [
  BrowserModule,
  ContactModule,
  CoreModule.forRoot({userName: 'Miss Marple'}),
  AppRoutingModule
],

Prevent reimport of the CoreModule

src/app/core/core.module.ts

constructor (@Optional() @SkipSelf() parentModule: CoreModule) {
  if (parentModule) {
    throw new Error(
      'CoreModule is already loaded. Import it in the AppModule only');
  }
}

Conclusion

Angular4スタイルガイド読む

angular

Angular公式のStyle Guideから気になった箇所を抜粋したものです。

Style GuideとNgModulesについての公式ドキュメントを読んだら、実際のアプリを作るときの大枠がある程度整理できました。

ドキュメントはそれなりに長いですが、命名規則など、Angular CLIを利用して入れば特に意識しなくても実現できている箇所も多いです。

Style Guide

Single responsibility

Consider limiting files to 400 lines of code.

Consider limiting to no more than 75 lines.

Naming

Coding conventions

Constants

Do declare variables with const if their values should not change during the application lifetime.

Interfaces

Do name an interface using upper camel case.

Consider naming an interface without an I prefix.

Consider using a class instead of an interface.

Application structure and Angular modules

All of the app’s code goes in a folder named src. All feature areas are in their own folder, with their own Angular module.

All third party vendor scripts are stored in another folder and not in the src folder.

LIFT

Locate

Identify

Flat

Consider creating sub-folders when a folder reaches seven or more files.

T-DRY

Why? Being DRY is important, but not crucial if it sacrifices the other elements of LIFT. That’s why it’s called T-DRY.

Overall structural guidelines

https://angular.io/guide/styleguide#file-tree

Folders-by-feature structure

Do create an Angular module for each feature area.

Shared feature module

Avoid providing services in shared modules. Services are usually singletons that are provided once for the entire application or in a particular feature module.

Do import all modules required by the assets in the SharedModule; for example, CommonModule and FormsModule.

Avoid specifying app-wide singleton providers in a SharedModule. Intentional singletons are OK. Take care.

Why? A lazy loaded feature module that imports that shared module will make its own copy of the service and likely have undesireable results.

Core feature module

Consider collecting numerous, auxiliary, single-use classes inside a core module to simplify the apparent structure of a feature module.

Do gather application-wide, single use components in the CoreModule. Import it once (in the AppModule) when the app starts and never import it anywhere else. (e.g. NavComponent and SpinnerComponent).

Prevent re-import of the core module

Do guard against reimporting of CoreModule and fail fast by adding guard logic.

export function throwIfAlreadyLoaded(parentModule: any, moduleName: string) {
  if (parentModule) {
    throw new Error(`${moduleName} has already been loaded. Import Core modules in the AppModule only.`);
  }
}

Components

Member sequence

Do place properties up top followed by methods.

Do place private members after public members, alphabetized.

Delegate complex component logic to services

Do limit logic in a component to only that required for the view. All other logic should be delegated to services.

/* avoid */
private hideSpinner() {
  // hide the spinner
}

Directives

HostListener/HostBinding decorators versus host metadata

Consider preferring the @HostListener and @HostBinding to the host property of the @Directive and @Component decorators.

Services

Providing a service

Do provide services to the Angular injector at the top-most component where they will be shared.

Why? When providing the service to a top level component, that instance is shared and available to all child components of that top level component.

Data Services

Lifecycle hooks

Appendix

Angular4さわる

angular

これは何か

新機能開発をAngular4で作り始めました。その時に調べたことのメモです。
Angular CLI使っています。

前提知識

調べたことメモ

Angular CLI

Autoprefixer

環境変数

上記ページ以外にもWikiのstoriesからいろいろ確認できます。
stories · angular/angular-cli Wiki · GitHub

IE9, IE10, IE11対応

  • src/polyfills.ts

ビルド

SCSS

VS Codeエクステンション

よかったチュートリアル

  1. The Ultimate Angular CLI Reference Guide — SitePoint
  2. Angular 2 Tutorial: Create a CRUD App with Angular CLI — SitePoint
  3. Understanding Component Architecture: Refactoring an Angular App — SitePoint
  4. Angular and RxJS: Create an API Service to Talk to a REST Backend — SitePoint

Angular CLIを利用したチュートリアルのシリーズです。
Githubにコードがあります。
GitHub - sitepoint-editors/angular-todo-app: Todo app for Angular2+

画像を内接リサイズにする

css

f:id:ryotah:20170619212705p:plain

css - Resize to fit image in div, and center horizontally and vertically - Stack Overflow

transformとposition: absoluteを利用します。

前の記事のアスペクト比を保つcssを利用するとこんな感じです。

object-fitというプロパティを利用すればもっと簡単でした。（でもIEには対応していない）
object-fit - CSS | MDN

アスペクト比を保つ

css

f:id:ryotah:20170619205403p:plain

「padding-topに%を設定すると、包括しているブロックの幅を基準にする」という仕様を利用します。

padding-top - CSS | MDN

以下のコードは、アスペクト比を4:3にする場合。

.a43 {
  border: 1px solid #000;
  width: 160px;
  position: relative;
}
.a43:before {
  content: '';
  display: block;

  /* アスペクト比 4:3 */
  padding-top:75%;
}
.a43-inner {
  position: absolute;
  top: 0;
}

<div class="a43">
  <div class="a43-inner">
    foo<br>
    bar
  </div>
</div>

AngularでBugsnagを利用

Angular4始めました。
Angularでエラーをインターセプトする場合はこんな感じ。

import { ErrorHandler, Injectable} from '@angular/core';
import { environment } from '../environments/environment';

@Injectable()
export class GlobalErrorHandler implements ErrorHandler {
  constructor() {
    Bugsnag.releaseStage =  = environment.production ? 'production' : 'develop';
  }
  handleError(error) {
    Bugsnag.notifyException(error);
    throw error;
  }
}

// ---

@NgModule({
  providers: [{
    provide: ErrorHandler,
    useClass: GlobalErrorHandler
  }]
})
export class AppModule { }

https://angular.io/api/core/ErrorHandler

VS Codeでタイトルバーの色変更

f:id:ryotah:20170616111352p:plain

複数のプロジェクトやライブラリをみる場合に便利。
画像の例は、自分の仕事とAngularとBootstrap4を開いている場合。

// Place your settings in this file to overwrite default and user settings.
{
  "workbench.colorCustomizations": {
    "titleBar.activeBackground": "#1976d2"
  }
}

VS Code Theme Color Reference