Tutorial: Criar um aplicativo Angular e prepará-lo para autenticação

Artigo
11/12/2024

Após a conclusão do registro, um projeto Angular pode ser criado usando Angular CLI (Command Line Interface). Este tutorial demonstra como criar um aplicativo Angular de página única usando a CLI Angular e criar arquivos necessários para autenticação e autorização.

Neste tutorial:

Criar um novo projeto Angular
Definir as configurações para o aplicativo
Adicionar código de autenticação ao aplicativo

Pré-requisitos

Conclusão dos pré-requisitos e etapas em Tutorial: Registrar uma inscrição.
Instalar Agular CLI
Instale Node.js.
Visual Studio Code

Criar um novo projeto Angular

Para construir o projeto Angular a partir do zero, siga estas etapas:

Abra uma janela do terminal e execute o seguinte comando para criar um novo projeto Angular:
```
ng new msal-angular-tutorial --routing=true --style=css --strict=false
```
O comando cria um novo projeto Angular nomeado msal-angular-tutorial com roteamento habilitado, CSS para estilo e modo estrito desativado.
Alterar para o diretório do projeto:
```
cd msal-angular-tutorial
```
Instale as dependências do aplicativo:
```
npm install @azure/msal-browser @azure/msal-angular bootstrap
```
O comando npm install @azure/msal-browser @azure/msal-angular bootstrap instala o navegador MSAL do Azure, o Azure MSAL Angular e os pacotes Bootstrap.
Abra angular.json e adicione o styles caminho CSS do Bootstrap à matriz:
```
"styles": [
    "src/styles.css",
    "node_modules/bootstrap/dist/css/bootstrap.min.css"
],
```
O código adiciona o Bootstrap CSS à matriz de estilos no angular.json arquivo.
Gerar componentes Home e Profile:
```
ng generate component home
ng generate component profile
```
Os comandos geram os componentes Home e Profile no projeto Angular.

Remova arquivos e códigos desnecessários do projeto:

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

Os comandos removem arquivos e códigos desnecessários do projeto.

Renomeie app.routes.ts para usar o app-routing.module.ts Visual Studio Code e atualize todas as referências de app.routes.ts todo o aplicativo.
Renomeie app.config.ts para usar o app.module.ts Visual Studio Code e atualize todas as referências em app.config.ts todo o aplicativo.

Depois de concluir essas etapas, a estrutura do projeto deve ter a seguinte aparência:

.
├── 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

Definir as configurações para o aplicativo

Usaremos os valores registrados durante o registro do aplicativo para configurar o aplicativo para autenticação. Siga estes passos:

Abra o src/app/app.module.ts arquivo e substitua o conteúdo pelo seguinte código:

// 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 { }

O código configura o MSAL para autenticação de usuário e proteção de API. Ele configura o aplicativo com MsalInterceptor para proteger solicitações de API e MsalGuard rotas de proteção, enquanto define os principais componentes e serviços para autenticação. Substitua os seguintes valores pelos valores do centro de administração do Microsoft Entra.

Substitua Enter_the_Application_Id_Here pelo Application (client) ID registro do aplicativo.
Substitua Enter_the_Tenant_Info_Here pelo Directory (tenant) ID registro do aplicativo.

Guarde o ficheiro.

Adicionar código de autenticação ao aplicativo

Para lidar com a autenticação do usuário e o gerenciamento de sessão usando o MSAL Angular, você precisará atualizar src/app/app.component.tso .

Abra src/app/app.component.ts o arquivo e substitua o conteúdo pelo seguinte código:

// 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();
  }
}

O código integra o MSAL com o Angular para gerenciar a autenticação do usuário. Ele escuta as alterações de status de entrada, exibe o estado de entrada, manipula eventos de aquisição de token e fornece métodos para fazer login ou saída de usuários com base na configuração do Microsoft Entra.

Guarde o ficheiro.

Próximos passos

Tutorial: Adicionar componentes funcionais de entrada e saída em um aplicativo Angular

Partilhar via