Angular2 - 如何将窗口注入angular2服务

时间:2015-12-09 11:05:42

标签: dependency-injection typescript angular

我在TypeScript中编写一个Angular2服务,它将使用localstorage。我想将浏览器窗口对象的引用注入我的服务,因为我不想引用任何全局变量。像angular 1.x $window一样。我该怎么做?

21 个答案:

答案 0 :(得分:124)

目前这对我有用(2018-03,带有AoT的角度5.2,在angular-cli和自定义webpack版本中测试):

首先,创建一个注入服务,提供对window的引用:

import { Injectable } from '@angular/core';

// This interface is optional, showing how you can add strong typings for custom globals.
// Just use "Window" as the type if you don't have custom global stuff
export interface ICustomWindow extends Window {
    __custom_global_stuff: string;
}

function getWindow (): any {
    return window;
}

@Injectable()
export class WindowRefService {
    get nativeWindow (): ICustomWindow {
        return getWindow();
    }
}

现在,使用您的根AppModule注册该服务,以便可以在任何地方注入:

import { WindowRefService } from './window-ref.service';

@NgModule({        
  providers: [
    WindowRefService 
  ],
  ...
})
export class AppModule {}

然后稍后您需要注入window

import { Component} from '@angular/core';
import { WindowRefService, ICustomWindow } from './window-ref.service';

@Component({ ... })
export default class MyCoolComponent {
    private _window: ICustomWindow;

    constructor (
        windowRef: WindowRefService
    ) {
        this._window = windowRef.nativeWindow;
    }

    public doThing (): void {
        let foo = this._window.XMLHttpRequest;
        let bar = this._window.__custom_global_stuff;
    }
...

如果您在应用程序中使用这些服务,您可能还希望以类似的方式将nativeDocument和其他全局变量添加到此服务中。

编辑: 更新了Truchainz的建议。 EDIT2: 针对角度2.1.2进行了更新 EDIT3: 添加了AoT笔记 edit4: 添加any类型的变通方法说明 edit5:更新了使用WindowRefService的解决方案,该解决方案修复了在使用不同版本的先前解决方案时遇到的错误 edit6:添加示例自定义窗口输入

答案 1 :(得分:30)

随着角度2.0.0-rc的发布,引入了NgModule。之前的解决方案停止了为我工作。这就是我所做的修复它:

app.module.ts:

@NgModule({        
  providers: [
    { provide: 'Window',  useValue: window }
  ],
  declarations: [...],
  imports: [...]
})
export class AppModule {}

在某些组成部分:

import { Component, Inject } from '@angular/core';

@Component({...})
export class MyComponent {
    constructor (@Inject('Window') window: Window) {}
}

您还可以使用OpaqueToken代替字符串' Window'

编辑:

AppModule用于在main.ts中引导您的应用程序,如下所示:

import { platformBrowserDynamic  } from '@angular/platform-browser-dynamic';
import { AppModule } from './app/app.module';

platformBrowserDynamic().bootstrapModule(AppModule)

有关NgModule的更多信息,请阅读Angular 2文档:https://angular.io/docs/ts/latest/guide/ngmodule.html

答案 2 :(得分:17)

您可以在设置提供商后注入它:

import {provide} from 'angular2/core';
bootstrap(..., [provide(Window, {useValue: window})]);

constructor(private window: Window) {
    // this.window
}

答案 3 :(得分:13)

要使它在Angular 2.1.1上运行,我必须使用字符串

@Inject窗口
  constructor( @Inject('Window') private window: Window) { }

然后像这样嘲笑

beforeEach(() => {
  let windowMock: Window = <any>{ };
  TestBed.configureTestingModule({
    providers: [
      ApiUriService,
      { provide: 'Window', useFactory: (() => { return windowMock; }) }
    ]
  });

在普通的@NgModule我提供了这样的

{ provide: 'Window', useValue: window }

答案 4 :(得分:9)

我使用OpaqueToken用于&#39; Window&#39; string:

import {unimplemented} from '@angular/core/src/facade/exceptions';
import {OpaqueToken, Provider} from '@angular/core/index';

function _window(): any {
    return window;
}

export const WINDOW: OpaqueToken = new OpaqueToken('WindowToken');

export abstract class WindowRef {
    get nativeWindow(): any {
        return unimplemented();
    }
}

export class BrowserWindowRef extends WindowRef {
    constructor() {
        super();
    }
    get nativeWindow(): any {
        return _window();
    }
}


export const WINDOW_PROVIDERS = [
    new Provider(WindowRef, { useClass: BrowserWindowRef }),
    new Provider(WINDOW, { useFactory: _window, deps: [] }),
];

用于在Angular 2.0.0-rc-4中的bootstrap中导入WINDOW_PROVIDERS

但随着Angular 2.0.0-rc.5的发布,我需要创建一个单独的模块:

import { NgModule } from '@angular/core';
import { WINDOW_PROVIDERS } from './window';

@NgModule({
    providers: [WINDOW_PROVIDERS]
})
export class WindowModule { }

并且刚刚在我的主app.module.ts

的imports属性中定义
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { WindowModule } from './other/window.module';

import { AppComponent } from './app.component';

@NgModule({
    imports: [ BrowserModule, WindowModule ],
    declarations: [ ... ],
    providers: [ ... ],
    bootstrap: [ AppComponent ]
})
export class AppModule {}

答案 5 :(得分:9)

在Angular RC4中,以下作为上述一些答案的组合,在你的根app.ts中添加提供者:

@Component({
    templateUrl: 'build/app.html',
    providers: [
        anotherProvider,
        { provide: Window, useValue: window }
    ]
})

然后在你的服务等中将它注入构造函数

constructor(
      @Inject(Window) private _window: Window,
)

答案 6 :(得分:9)

在@Component声明之前,你也可以这样做,

declare var window: any;

编译器实际上允许您现在访问全局窗口变量,因为您将其声明为具有类型any的假定全局变量。

我不建议在应用程序的任何地方访问窗口,但是您应该创建访问/修改所需窗口属性的服务(并在组件中注入这些服务),以便在不使用窗口的情况下对窗口进行操作让他们修改整个窗口对象。

答案 7 :(得分:7)

您可以从注入的文档中获取窗口。

import { Inject } from '@angular/core';
import { DOCUMENT } from '@angular/common';

export class MyClass {

  constructor(@Inject(DOCUMENT) private document: Document) {
     this.window = this.document.defaultView;
  }

  check() {
    console.log(this.document);
    console.log(this.window);
  }

}

答案 8 :(得分:6)

截至今天(2016年4月),上一个解决方案中的代码不起作用,我认为可以将窗口直接注入到App.ts中,然后将所需的值收集到服务中以进行全局访问。应用程序,但如果您更喜欢创建和注入自己的服务,那么这就是一种更简单的解决方案。

https://gist.github.com/WilldelaVega777/9afcbd6cc661f4107c2b74dd6090cebf

//--------------------------------------------------------------------------------------------------
// Imports Section:
//--------------------------------------------------------------------------------------------------
import {Injectable} from 'angular2/core'
import {window} from 'angular2/src/facade/browser';

//--------------------------------------------------------------------------------------------------
// Service Class:
//--------------------------------------------------------------------------------------------------
@Injectable()
export class WindowService
{
    //----------------------------------------------------------------------------------------------
    // Constructor Method Section:
    //----------------------------------------------------------------------------------------------
    constructor(){}

    //----------------------------------------------------------------------------------------------
    // Public Properties Section:
    //----------------------------------------------------------------------------------------------
    get nativeWindow() : Window
    {
        return window;
    }
}

答案 9 :(得分:6)

Angular 4引入了InjectToken,它们还为名为DOCUMENT的文档创建了一个令牌。我认为这是官方解决方案,它可以在AoT中使用。

我使用相同的逻辑创建一个名为ngx-window-token的小型库,以防止一遍又一遍地执行此操作。

我已经在其他项目中使用过它并在没有问题的情况下在AoT中构建。

以下是我在other package

中使用它的方法

以下是plunker

在你的模块中

imports: [ BrowserModule, WindowTokenModule ] 在您的组件中

constructor(@Inject(WINDOW) _window) { }

答案 10 :(得分:4)

有机会通过文档直接访问窗口对象

document.defaultView == window

答案 11 :(得分:3)

这是我发现使用Angular 4 AOT的最短/最干净的答案

来源: https://github.com/angular/angular/issues/12631#issuecomment-274260009

@Injectable()
export class WindowWrapper extends Window {}

export function getWindow() { return window; }

@NgModule({
  ...
  providers: [
    {provide: WindowWrapper, useFactory: getWindow}
  ]
  ...
})
export class AppModule {
  constructor(w: WindowWrapper) {
    console.log(w);
  }
}

答案 12 :(得分:3)

这就足够了

export class AppWindow extends Window {} 

并做

{ provide: 'AppWindow', useValue: window } 

让AOT高兴

答案 13 :(得分:3)

我知道问题是如何将窗口对象注入到组件中,但是您只是为了到达localStorage而这样做。如果你真的只想要localStorage,为什么不使用那种公开的服务,比如h5webstorage。然后,您的组件将描述其真正的依赖关系,使您的代码更具可读性。

答案 14 :(得分:2)

你可以在Angular 4上使用NgZone:

import { NgZone } from '@angular/core';

constructor(private zone: NgZone) {}

print() {
    this.zone.runOutsideAngular(() => window.print());
}

答案 15 :(得分:1)

DOCUMENT标记为可选也是一个好主意。根据Angular文档:

  

当应用程序上下文和呈现上下文不同时(例如,将应用程序运行到Web Worker中时),文档可能在应用程序上下文中不可用。

下面是使用DOCUMENT来查看浏览器是否支持SVG的示例:

import { Optional, Component, Inject } from '@angular/core';
import { DOCUMENT } from '@angular/common'

...

constructor(@Optional() @Inject(DOCUMENT) document: Document) {
   this.supportsSvg = !!(
   document &&
   document.createElementNS &&
   document.createElementNS('http://www.w3.org/2000/svg', 'svg').createSVGRect
);

答案 16 :(得分:0)

@maxisam感谢ngx-window-token。我做了类似的事情,但转到你的。这是我收听窗口调整大小事件和通知订阅者的服务。

import { Inject, Injectable } from '@angular/core';
import { BehaviorSubject } from 'rxjs/BehaviorSubject';
import { Observable } from 'rxjs/Observable';
import 'rxjs/add/observable/fromEvent';
import { WINDOW } from 'ngx-window-token';


export interface WindowSize {
    readonly width: number;
    readonly height: number;
}

@Injectable()
export class WindowSizeService {

    constructor( @Inject(WINDOW) private _window: any ) {
        Observable.fromEvent(_window, 'resize')
        .auditTime(100)
        .map(event => <WindowSize>{width: event['currentTarget'].innerWidth, height: event['currentTarget'].innerHeight})
        .subscribe((windowSize) => {
            this.windowSizeChanged$.next(windowSize);
        });
    }

    readonly windowSizeChanged$ = new BehaviorSubject<WindowSize>(<WindowSize>{width: this._window.innerWidth, height: this._window.innerHeight});
}

短而甜美,就像一个魅力。

答案 17 :(得分:0)

在整个应用程序中可以访问全局变量时,通过DI(依赖注入)获取窗口对象并不是一个好主意。

但是如果您不想使用窗口对象,那么您也可以使用self关键字,该关键字也指向窗口对象。

答案 18 :(得分:0)

这是我最近厌倦了从defaultView内置令牌中获取DOCUMENT并检查其是否为空之后提出的另一种解决方案:

import {DOCUMENT} from '@angular/common';
import {inject, InjectionToken} from '@angular/core';

export const WINDOW = new InjectionToken<Window>(
    'An abstraction over global window object',
    {
        factory: () => {
            const {defaultView} = inject(DOCUMENT);

            if (!defaultView) {
                throw new Error('Window is not available');
            }

            return defaultView;
        }
    });

答案 19 :(得分:-1)

伙计,保持简单!

export class HeroesComponent implements OnInit {
  heroes: Hero[];
  window = window;
}

<div>{{window.Object.entries({ foo: 1 }) | json}}</div>

答案 20 :(得分:-1)

实际上,访问窗口对象非常简单 这是我的基本组件,我对其进行了测试

import { Component, OnInit,Inject } from '@angular/core';
import {DOCUMENT} from '@angular/platform-browser';

@Component({
  selector: 'app-verticalbanners',
  templateUrl: './verticalbanners.component.html',
  styleUrls: ['./verticalbanners.component.css']
})
export class VerticalbannersComponent implements OnInit {

  constructor(){ }

  ngOnInit() {
    console.log(window.innerHeight );
  }

}