Angularを使用したSpringSecurityログインページ
1. 概要
このチュートリアルでは、Springセキュリティを使用してログインページを作成します:
- AngularJS
- Angular 2、4、5、および6
ここで説明するサンプルアプリケーションは、基本HTTP認証で保護されたRESTサービスと通信するクライアントアプリケーションで構成されています。
2. Springセキュリティ構成
まず、Springセキュリティと基本認証を使用してRESTAPIを設定しましょう。
構成方法は次のとおりです。
@Configuration
@EnableWebSecurity
public class BasicAuthConfiguration
extends WebSecurityConfigurerAdapter {
@Override
protected void configure(AuthenticationManagerBuilder auth)
throws Exception {
auth
.inMemoryAuthentication()
.withUser("user")
.password("password")
.roles("USER");
}
@Override
protected void configure(HttpSecurity http)
throws Exception {
http.csrf().disable()
.authorizeRequests()
.antMatchers("/login").permitAll()
.anyRequest()
.authenticated()
.and()
.httpBasic();
}
}
次に、エンドポイントを作成しましょう。 私たちのRESTサービスには2つあります。1つはログイン用で、もう1つはユーザーデータのフェッチ用です。
@RestController
@CrossOrigin
public class UserController {
@RequestMapping("/login")
public boolean login(@RequestBody User user) {
return
user.getUserName().equals("user") && user.getPassword().equals("password");
}
@RequestMapping("/user")
public Principal user(HttpServletRequest request) {
String authToken = request.getHeader("Authorization")
.substring("Basic".length()).trim();
return () -> new String(Base64.getDecoder()
.decode(authToken)).split(":")[0];
}
}
同様に、承認のためにOAuth2サーバーを実装することに興味がある場合は、SpringセキュリティOAuth2に関する他のチュートリアルも確認できます。
3. Angularクライアントのセットアップ
RESTサービスを作成したので、さまざまなバージョンのAngularクライアントを使用してログインページを設定しましょう。
ここで説明する例では、依存関係の管理に npm を使用し、アプリケーションの実行にnodejsを使用しています。
Angularは、すべての子コンポーネント(この場合はログインコンポーネントとホームコンポーネント)が共通の親DOMに挿入される単一ページアーキテクチャを使用します。
JavaScriptを使用するAngularJSとは異なり、Angularバージョン2以降ではTypeScriptをメイン言語として使用します。 したがって、アプリケーションは、正しく機能するために必要な特定のサポートファイルも必要とします。
Angularの段階的な拡張により、必要なファイルはバージョンごとに異なります。
これらのそれぞれに慣れましょう:
- systemjs.config.js –システム構成(バージョン2)
- package.json –ノードモジュールの依存関係(バージョン2以降)
- tsconfig.json –ルートレベルのTypescript構成(バージョン2以降)
- tsconfig.app.json –アプリケーションレベルのTypescript構成(バージョン4以降)
- .angular- cli .json – Angular CLI構成(バージョン4および5)
- angle.json – Angular CLI構成(バージョン6以降)
4. ログインページ
4.1. AngularJSの使用
index.html ファイルを作成し、それに関連する依存関係を追加しましょう。
<html ng-app="app">
<body>
<div ng-view></div>
<script src="//code.jquery.com/jquery-3.1.1.min.js"></script>
<script src="//code.angularjs.org/1.6.0/angular.min.js"></script>
<script src="//code.angularjs.org/1.6.0/angular-route.min.js"></script>
<script src="app.js"></script>
<script src="home/home.controller.js"></script>
<script src="login/login.controller.js"></script>
</body>
</html>
これはシングルページアプリケーションであるため、すべての子コンポーネントは、ルーティングロジックに基づいてng-view属性を使用してdiv要素に追加されます。
次に、URLからコンポーネントへのマッピングを定義するapp.jsを作成しましょう。
(function () {
'use strict';
angular
.module('app', ['ngRoute'])
.config(config)
.run(run);
config.$inject = ['$routeProvider', '$locationProvider'];
function config($routeProvider, $locationProvider) {
$routeProvider.when('/', {
controller: 'HomeController',
templateUrl: 'home/home.view.html',
controllerAs: 'vm'
}).when('/login', {
controller: 'LoginController',
templateUrl: 'login/login.view.html',
controllerAs: 'vm'
}).otherwise({ redirectTo: '/login' });
}
run.$inject = ['$rootScope', '$location', '$http', '$window'];
function run($rootScope, $location, $http, $window) {
var userData = $window.sessionStorage.getItem('userData');
if (userData) {
$http.defaults.headers.common['Authorization']
= 'Basic ' + JSON.parse(userData).authData;
}
$rootScope
.$on('$locationChangeStart', function (event, next, current) {
var restrictedPage
= $.inArray($location.path(), ['/login']) === -1;
var loggedIn
= $window.sessionStorage.getItem('userData');
if (restrictedPage && !loggedIn) {
$location.path('/login');
}
});
}
})();
ログインコンポーネントは、2つのファイルで構成されています。 login.controller.js 、 そしてその
最初のものを見てみましょう:
<h2>Login</h2>
<form name="form" ng-submit="vm.login()" role="form">
<div>
<label for="username">Username</label>
<input type="text" name="username"
id="username" ng-model="vm.username" required />
<span ng-show="form.username.$dirty
&& form.username.$error.required">Username is required</span>
</div>
<div>
<label for="password">Password</label>
<input type="password"
name="password" id="password" ng-model="vm.password" required />
<span ng-show="form.password.$dirty
&& form.password.$error.required">Password is required</span>
</div>
<div class="form-actions">
<button type="submit"
ng-disabled="form.$invalid || vm.dataLoading">Login</button>
</div>
</form>
そして2番目のもの:
(function () {
'use strict';
angular
.module('app')
.controller('LoginController', LoginController);
LoginController.$inject = ['$location', '$window', '$http'];
function LoginController($location, $window, $http) {
var vm = this;
vm.login = login;
(function initController() {
$window.localStorage.setItem('token', '');
})();
function login() {
$http({
url: 'http://localhost:8082/login',
method: "POST",
data: {
'userName': vm.username,
'password': vm.password
}
}).then(function (response) {
if (response.data) {
var token
= $window.btoa(vm.username + ':' + vm.password);
var userData = {
userName: vm.username,
authData: token
}
$window.sessionStorage.setItem(
'userData', JSON.stringify(userData)
);
$http.defaults.headers.common['Authorization']
= 'Basic ' + token;
$location.path('/');
} else {
alert("Authentication failed.")
}
});
};
}
})();
コントローラは、ユーザー名とパスワードを渡すことでRESTサービスを呼び出します。 認証が成功すると、ユーザー名とパスワードがエンコードされ、エンコードされたトークンが将来の使用のためにセッションストレージに保存されます。
ログインコンポーネントと同様に、ホームコンポーネントも home.view.html :の2つのファイルで構成されています。
<h1>Hi {{vm.user}}!</h1>
<p>You're logged in!!</p>
<p><a href="#!/login" class="btn btn-primary" ng-click="logout()">Logout</a></p>
およびhome.controller.js:
(function () {
'use strict';
angular
.module('app')
.controller('HomeController', HomeController);
HomeController.$inject = ['$window', '$http', '$scope'];
function HomeController($window, $http, $scope) {
var vm = this;
vm.user = null;
initController();
function initController() {
$http({
url: 'http://localhost:8082/user',
method: "GET"
}).then(function (response) {
vm.user = response.data.name;
}, function (error) {
console.log(error);
});
};
$scope.logout = function () {
$window.sessionStorage.setItem('userData', '');
$http.defaults.headers.common['Authorization'] = 'Basic';
}
}
})();
ホームコントローラーは、Authorizationヘッダーを渡すことによってユーザーデータを要求します。 私たちのRESTサービスは、トークンが有効な場合にのみユーザーデータを返します。
次に、Angularアプリケーションを実行するためにhttp-serverをインストールしましょう。
npm install http-server --save
これをインストールしたら、コマンドプロンプトでプロジェクトのルートフォルダーを開き、次のコマンドを実行できます。
http-server -o
4.2. Angularバージョン2、4、5を使用する
バージョン2のindex.htmlは、AngularJSバージョンとは少し異なります。
<!DOCTYPE html>
<html>
<head>
<base href="/" />
<script src="node_modules/core-js/client/shim.min.js"></script>
<script src="node_modules/zone.js/dist/zone.js"></script>
<script src="node_modules/systemjs/dist/system.src.js"></script>
<script src="systemjs.config.js"></script>
<script>
System.import('app').catch(function (err) { console.error(err); });
</script>
</head>
<body>
<app>Loading...</app>
</body>
</html>
main.ts は、アプリケーションのメインエントリポイントです。 アプリケーションモジュールをブートストラップし、その結果、ブラウザはログインページをロードします。
platformBrowserDynamic().bootstrapModule(AppModule);
app.routing.ts は、アプリケーションのルーティングを担当します。
const appRoutes: Routes = [
{ path: '', component: HomeComponent },
{ path: 'login', component: LoginComponent },
{ path: '**', redirectTo: '' }
];
export const routing = RouterModule.forRoot(appRoutes);
app.module.ts はコンポーネントを宣言し、関連するモジュールをインポートします。
@NgModule({
imports: [
BrowserModule,
FormsModule,
HttpModule,
routing
],
declarations: [
AppComponent,
HomeComponent,
LoginComponent
],
bootstrap: [AppComponent]
})
export class AppModule { }
シングルページアプリケーションを作成しているので、すべての子コンポーネントを追加するルートコンポーネントを作成しましょう。
@Component({
selector: 'app-root',
templateUrl: './app.component.html'
})
export class AppComponent { }
The app.component.html のみがあります
次に、 login.component.ts:にログインコンポーネントとそれに対応するテンプレートを作成しましょう。
@Component({
selector: 'login',
templateUrl: './app/login/login.component.html'
})
export class LoginComponent implements OnInit {
model: any = {};
constructor(
private route: ActivatedRoute,
private router: Router,
private http: Http
) { }
ngOnInit() {
sessionStorage.setItem('token', '');
}
login() {
let url = 'http://localhost:8082/login';
let result = this.http.post(url, {
userName: this.model.username,
password: this.model.password
}).map(res => res.json()).subscribe(isValid => {
if (isValid) {
sessionStorage.setItem(
'token',
btoa(this.model.username + ':' + this.model.password)
);
this.router.navigate(['']);
} else {
alert("Authentication failed.");
}
});
}
}
最後に、login.component.htmlを見てみましょう。
<form name="form" (ngSubmit)="f.form.valid && login()" #f="ngForm" novalidate>
<div [ngClass]="{ 'has-error': f.submitted && !username.valid }">
<label for="username">Username</label>
<input type="text"
name="username" [(ngModel)]="model.username"
#username="ngModel" required />
<div *ngIf="f.submitted
&& !username.valid">Username is required</div>
</div>
<div [ngClass]="{ 'has-error': f.submitted && !password.valid }">
<label for="password">Password</label>
<input type="password"
name="password" [(ngModel)]="model.password"
#password="ngModel" required />
<div *ngIf="f.submitted
&& !password.valid">Password is required</div>
</div>
<div>
<button [disabled]="loading">Login</button>
</div>
</form>
4.3. Angular6の使用
Angularチームはバージョン6でいくつかの機能強化を行いました。 これらの変更により、この例も他のバージョンとは少し異なります。 バージョン6に関してこの例で行った唯一の変更は、サービス呼び出し部分です。
HttpModule の代わりに、バージョン6はHttpClientModuleをからインポートします。 @ angle / common/http。
サービス呼び出し部分も、以前のバージョンとは少し異なります。
this.http.post<Observable<boolean>>(url, {
userName: this.model.username,
password: this.model.password
}).subscribe(isValid => {
if (isValid) {
sessionStorage.setItem(
'token',
btoa(this.model.username + ':' + this.model.password)
);
this.router.navigate(['']);
} else {
alert("Authentication failed.")
}
});
5. 結論
AngularでSpringセキュリティログインページを実装する方法を学びました。 バージョン4以降では、AngularCLIプロジェクトを利用して開発とテストを簡単に行うことができます。
いつものように、ここで説明したすべての例は、GitHubプロジェクトにあります。