Samouczek: tworzenie aplikacji Angular i przygotowywanie jej do uwierzytelniania

Artykuł
11/12/2024

Po zakończeniu rejestracji można utworzyć projekt Angular przy użyciu interfejsu wiersza polecenia platformy Angular. W tym samouczku pokazano, jak utworzyć jednostronicową aplikację Angular przy użyciu interfejsu wiersza polecenia platformy Angular i utworzyć pliki potrzebne do uwierzytelniania i autoryzacji.

W tym samouczku:

Tworzenie nowego projektu Angular
Konfigurowanie ustawień aplikacji
Dodawanie kodu uwierzytelniania do aplikacji

Wymagania wstępne

Ukończenie wymagań wstępnych i kroków w temacie Samouczek: rejestrowanie aplikacji.
Instalowanie interfejsu wiersza polecenia agular
Zainstaluj Node.js.
Visual Studio Code

Tworzenie nowego projektu Angular

Aby skompilować projekt Angular od podstaw, wykonaj następujące kroki:

Otwórz okno terminalu i uruchom następujące polecenie, aby utworzyć nowy projekt Angular:
```
ng new msal-angular-tutorial --routing=true --style=css --strict=false
```
Polecenie tworzy nowy projekt Angular o nazwie msal-angular-tutorial z włączonym routingiem, CSS na potrzeby stylów i wyłączonym trybem ścisłym.
Przejdź do katalogu projektu:
```
cd msal-angular-tutorial
```
Zainstaluj zależności aplikacji:
```
npm install @azure/msal-browser @azure/msal-angular bootstrap
```
npm install @azure/msal-browser @azure/msal-angular bootstrap Polecenie instaluje pakiety Azure MSAL Browser, Azure MSAL Angular i Bootstrap.
Otwórz angular.json i dodaj ścieżkę CSS bootstrap do tablicy styles :
```
"styles": [
    "src/styles.css",
    "node_modules/bootstrap/dist/css/bootstrap.min.css"
],
```
Kod dodaje kod Bootstrap CSS do tablicy stylów w angular.json pliku.
Generowanie składników strony głównej i profilu:
```
ng generate component home
ng generate component profile
```
Polecenia generują składniki Strona główna i Profil w projekcie Angular.

Usuń niepotrzebne pliki i kod z projektu:

rm src/app/app.component.css
rm src/app/app.component.spec.ts
rm src/app/home/home.component.css
rm src/app/home/home.component.spec.ts
rm src/app/profile/profile.component.css
rm src/app/profile/profile.component.spec.ts

Polecenia usuwają niepotrzebne pliki i kod z projektu.

Zmień nazwę app.routes.ts na app-routing.module.ts przy użyciu programu Visual Studio Code i zaktualizuj wszystkie odwołania app.routes.ts w całej aplikacji.
Zmień nazwę app.config.ts na app.module.ts przy użyciu programu Visual Studio Code i zaktualizuj wszystkie odwołania do app.config.ts wszystkich odwołań w całej aplikacji.

Po wykonaniu tych kroków struktura projektu powinna wyglądać następująco:

.
├── README.md
├── angular.json
├── package-lock.json
├── package.json
├── src
│   ├── app
│   │   ├── app-routing.module.ts
│   │   ├── app.component.html
│   │   ├── app.component.ts
│   │   ├── app.module.ts
│   │   ├── home
│   │   │   ├── home.component.html
│   │   │   └── home.component.ts
│   │   └── profile
│   │       ├── profile.component.html
│   │       └── profile.component.ts
│   ├── index.html
│   ├── main.ts
│   ├── polyfills.ts
│   └── styles.css
├── tsconfig.app.json
└── tsconfig.json

Konfigurowanie ustawień aplikacji

Użyjemy wartości zarejestrowanych podczas rejestracji aplikacji, aby skonfigurować aplikację do uwierzytelniania. Wykonaj te kroki:

src/app/app.module.ts Otwórz plik i zastąp zawartość następującym kodem:

// Required for Angular multi-browser support
import { BrowserModule } from '@angular/platform-browser';

// Required for Angular
import { NgModule } from '@angular/core';

// Required modules and components for this application
import { AppRoutingModule } from './app-routing.module';
import { AppComponent } from './app.component';
import { ProfileComponent } from './profile/profile.component';
import { HomeComponent } from './home/home.component';

// HTTP modules required by MSAL
import { HTTP_INTERCEPTORS, HttpClientModule } from '@angular/common/http';

// Required for MSAL
import { IPublicClientApplication, PublicClientApplication, InteractionType, BrowserCacheLocation, LogLevel } from '@azure/msal-browser';
import { MsalGuard, MsalInterceptor, MsalBroadcastService, MsalInterceptorConfiguration, MsalModule, MsalService, MSAL_GUARD_CONFIG, MSAL_INSTANCE, MSAL_INTERCEPTOR_CONFIG, MsalGuardConfiguration, MsalRedirectComponent } from '@azure/msal-angular';

const isIE = window.navigator.userAgent.indexOf('MSIE ') > -1 || window.navigator.userAgent.indexOf('Trident/') > -1;

export function MSALInstanceFactory(): IPublicClientApplication {
  return new PublicClientApplication({
    auth: {
      // 'Application (client) ID' of app registration in the Microsoft Entra admin center - this value is a GUID
      clientId: "Enter_the_Application_Id_Here",
      // Full directory URL, in the form of https://login.microsoftonline.com/<tenant>
      authority: "https://login.microsoftonline.com/Enter_the_Tenant_Info_Here",
      // Must be the same redirectUri as what was provided in your app registration.
      redirectUri: "http://localhost:4200",
    },
    cache: {
      cacheLocation: BrowserCacheLocation.LocalStorage,
      storeAuthStateInCookie: isIE
    }
  });
}

// MSAL Guard is required to protect routes and require authentication before accessing protected routes
export function MSALGuardConfigFactory(): MsalGuardConfiguration {
  return { 
    interactionType: InteractionType.Redirect,
    authRequest: {
      scopes: ['user.read']
    }
  };
}

// Create an NgModule that contains the routes and MSAL configurations
@NgModule({
  declarations: [
    AppComponent,
    HomeComponent,
    ProfileComponent
  ],
  imports: [
    BrowserModule,
    AppRoutingModule,
    HttpClientModule,
    MsalModule
  ],
  providers: [
    {
      provide: HTTP_INTERCEPTORS,
      useClass: MsalInterceptor,
      multi: true
    },
    {
      provide: MSAL_INSTANCE,
      useFactory: MSALInstanceFactory
    },
    {
      provide: MSAL_GUARD_CONFIG,
      useFactory: MSALGuardConfigFactory
    },
    {
      provide: MSAL_INTERCEPTOR_CONFIG,
      useFactory: MSALInterceptorConfigFactory
    },
    MsalService,
    MsalGuard,
    MsalBroadcastService
  ],
  bootstrap: [AppComponent, MsalRedirectComponent]
})
export class AppModule { }

Kod konfiguruje bibliotekę MSAL na potrzeby uwierzytelniania użytkowników i ochrony interfejsu API. Konfiguruje aplikację za pomocą MsalInterceptor polecenia , aby zabezpieczyć żądania interfejsu API i MsalGuard chronić trasy, definiując kluczowe składniki i usługi na potrzeby uwierzytelniania. Zastąp następujące wartości wartości wartościami z centrum administracyjnego firmy Microsoft Entra.

Zastąp Enter_the_Application_Id_Here ciąg ciągiem Application (client) ID z rejestracji aplikacji.
Zastąp Enter_the_Tenant_Info_Here ciąg ciągiem Directory (tenant) ID z rejestracji aplikacji.

Zapisz plik.

Dodawanie kodu uwierzytelniania do aplikacji

Aby obsługiwać uwierzytelnianie użytkowników i zarządzanie sesjami przy użyciu biblioteki MSAL Angular, należy zaktualizować src/app/app.component.tselement .

Otwórz src/app/app.component.ts plik i zastąp zawartość następującym kodem:

// Required for Angular
import { Component, OnInit, Inject, OnDestroy } from '@angular/core';

// Required for MSAL
import { MsalService, MsalBroadcastService, MSAL_GUARD_CONFIG, MsalGuardConfiguration } from '@azure/msal-angular';
import { EventMessage, EventType, InteractionStatus, RedirectRequest } from '@azure/msal-browser';

// Required for RJXS
import { Subject } from 'rxjs';
import { filter, takeUntil } from 'rxjs/operators';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html'
})
export class AppComponent implements OnInit, OnDestroy {
  title = 'Angular - MSAL Example';
  loginDisplay = false;
  tokenExpiration: string = '';
  private readonly _destroying$ = new Subject<void>();

  constructor(
    @Inject(MSAL_GUARD_CONFIG) private msalGuardConfig: MsalGuardConfiguration,
    private authService: MsalService,
    private msalBroadcastService: MsalBroadcastService
  ) { }

  // On initialization of the page, display the page elements based on the user state
  ngOnInit(): void {
    this.msalBroadcastService.inProgress$
        .pipe(
        filter((status: InteractionStatus) => status === InteractionStatus.None),
        takeUntil(this._destroying$)
      )
      .subscribe(() => {
        this.setLoginDisplay();
      });

      // Used for storing and displaying token expiration
      this.msalBroadcastService.msalSubject$.pipe(filter((msg: EventMessage) => msg.eventType === EventType.ACQUIRE_TOKEN_SUCCESS)).subscribe(msg => {
      this.tokenExpiration=  (msg.payload as any).expiresOn;
      localStorage.setItem('tokenExpiration', this.tokenExpiration);
    });
  }

  // If the user is logged in, present the user with a "logged in" experience
  setLoginDisplay() {
    this.loginDisplay = this.authService.instance.getAllAccounts().length > 0;
  }

  // Log the user in and redirect them if MSAL provides a redirect URI otherwise go to the default URI
  login() {
    if (this.msalGuardConfig.authRequest) {
      this.authService.loginRedirect({ ...this.msalGuardConfig.authRequest } as RedirectRequest);
    } else {
      this.authService.loginRedirect();
    }
  }

  // Log the user out
  logout() {
    this.authService.logoutRedirect();
  }

  ngOnDestroy(): void {
    this._destroying$.next(undefined);
    this._destroying$.complete();
  }
}

Kod integruje bibliotekę MSAL z platformą Angular w celu zarządzania uwierzytelnianiem użytkowników. Nasłuchuje zmian stanu logowania, wyświetla stan logowania, obsługuje zdarzenia pozyskiwania tokenów i udostępnia metody rejestrowania użytkowników w usłudze Microsoft Entra.

Zapisz plik.

Następne kroki

Samouczek: dodawanie składników funkcjonalnych logowania i wylogowywanie ich w aplikacji Angular

Udostępnij za pośrednictwem