Skip to content

Commit

Permalink
v1.0.0-Beta2の動作確認の結果見つかった不具合の修正 (#1842)
Browse files Browse the repository at this point in the history
* ・外部サイトへのリンクが新規ウィンドウで開いていない不具合の修正
・誤字の修正
・log4j2に関する記載の統一
・リンク先の修正

* Azure AD B2C認証サンプルのREADMEの内容をコードに合わせて最新化

* レビューコメントに対応
  • Loading branch information
kharada7 authored Jan 15, 2025
1 parent 109aa40 commit f062c78
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ HTTP 通信で発生する例外について、レスポンスやステータス

クライアントサイドの例外処理では、ユーザーが自身で対応できるか、という観点が重要になります。
たとえばセッションタイムアウトになるといったような場合は、ユーザーが再度ログインすることで対処できます。
一方 WebAPI サーバー内で予期しない問題が発生した場合、ユーザー自身では問題を解決できず、システム管理者に問い合わせをするようなフローが考えられます。
一方 Web API サーバー内で予期しない問題が発生した場合、ユーザー自身では問題を解決できず、システム管理者に問い合わせをするようなフローが考えられます。

ユーザーに対しては、自身がどのような対応をできるかを考慮し、適切な通知方法を選択します。ポップアップ等の画面遷移を伴わずに通知するか、エラーページへ遷移するかは、ユーザーが操作を継続できるかどうかによって選択します。
一方開発者向けの通知では、エラーの詳細を把握するために必要な情報を収集することが重要です。開発環境であればコンソールログに出力し、本番環境ではログ収集ツールに送信する、などが考えられます。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,16 @@ AlesInfiny Maia OSS Edition (以降、 AlesInfiny Maia)で定義するログ

## ロギングライブラリ {#logging-libraries}

AlesInfiny Maia では、 Java アプリケーションのロギングライブラリとして [Apache Log4j 2 :material-open-in-new:](https://logging.apache.org/log4j/2.x/){ target=_blank } を使用します。
<!-- textlint-disable ja-technical-writing/sentence-length -->

AlesInfiny Maia では、 Java アプリケーションのロギングライブラリとして [Apache Log4j 2 :material-open-in-new:](https://logging.apache.org/log4j/2.x/){ target=_blank } (以降 log4j2 )を使用します。
またロギングファサードとして [SLF4J :material-open-in-new:](https://www.slf4j.org/){ target=_blank } を使用します。

<!-- textlint-enable ja-technical-writing/sentence-length -->

### ログの設定ファイル {#logging-configuration-files}

log4j 2 では、設定ファイルを使用しログの動作を制御します。
log4j2 では、設定ファイルを使用しログの動作を制御します。

ログの設定ファイルは、以下の形式をサポートしています。
なお、 AlesInfiny Maia では、ログの設定ファイルに XML 形式を採用しています。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ dependencies {

<!-- textlint-enable ja-technical-writing/sentence-length -->

AlesInfiny Maia OSS Edition では、ロギングライブラリとして log4j 2 を使用します。
AlesInfiny Maia OSS Edition では、ロギングライブラリとして Apache Log4j 2 (以降 log4j2 )を使用します。
そのため、以下のようにデフォルトのロギングライブラリを依存関係から除外する設定を記述します。

``` groovy title="spring-boot-starter-logging の除外設定"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ batch プロジェクトで利用を推奨するライブラリは以下の通

- `spring-boot-starter-batch`: Spring Batch アプリケーションを構築するための依存関係を提供するスターター

- `spring-boot-starter-log4j2`: Spring Boot アプリケーションで log4j 2 を使用するためのスターター
- `spring-boot-starter-log4j2`: Spring Boot アプリケーションで Apache Log4j 2 (以降 log4j2 )を使用するためのスターター

- `spring-batch-test`: Spring Batch アプリケーションのテストのライブラリ

Expand Down Expand Up @@ -56,7 +56,7 @@ batch プロジェクトの `src/main/resource` 以下に `application.propertie

- [Spring Boot のアプリケーションプロパティ設定一覧 :material-open-in-new:](https://spring.pleiades.io/spring-boot/docs/current/reference/html/application-properties.html){ target=_blank }
- [本番対応機能 :material-open-in-new:](https://spring.pleiades.io/spring-boot/docs/current/reference/html/actuator.html){ target=_blank }
- [myBatis-spring-boot-starter のアプリケーションプロパティ設定一覧 :material-open-in-new:](https://mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/){ target=_blank }
- [myBatis-spring-boot-starter のアプリケーションプロパティ設定一覧 :material-open-in-new:](https://mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/#configuration){ target=_blank }

設定項目は多岐に渡るため、一般的に設定する項目について例示します。

Expand Down Expand Up @@ -112,7 +112,7 @@ batch プロジェクトの `src/main/resource` 以下に `application.propertie

<!-- textlint-enable ja-technical-writing/sentence-length -->

AlesInfiny Maia OSS Edition では、ロギングライブラリとして log4j 2 を使用します。
AlesInfiny Maia OSS Edition では、ロギングライブラリとして log4j2 を使用します。
そのため、以下のようにデフォルトのロギングライブラリを依存関係から除外する設定を記述します。

``` groovy title="spring-boot-starter-logging の除外設定"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ dependencies {

<!-- textlint-enable ja-technical-writing/sentence-length -->

AlesInfiny Maia OSS Edition では、ロギングライブラリとして log4j 2 を使用します。
AlesInfiny Maia OSS Edition では、ロギングライブラリとして Apache Log4j 2 (以降 log4j2)を使用します。
そのため、以下のようにデフォルトのロギングライブラリを依存関係から除外する設定を記述します。

``` groovy title="spring-boot-starter-logging の除外設定"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ spring.messages.basename=applicationcore.messages,systemcommon.messages

### メッセージの取得 {#getting-messages}

読み込んだプロパティファイルのメッセージを取得するためには、 [`MessageSource` :material-open-in-new:](https://spring.pleiades.io/spring-framework/docs/current/javadoc-api/org/springframework/context/MessageSource.html){ target=_blank } クラスを利用します
読み込んだプロパティファイルのメッセージを取得するためには、 [`MessageSource` :material-open-in-new:](https://spring.pleiades.io/spring-framework/docs/current/javadoc-api/org/springframework/context/MessageSource.html){ target=_blank } インターフェースを利用します

以下は、プロパティファイルからメッセージを取得し、ログに出力するためのエラーメッセージを整形する `ErrorMessageBuilder` クラスの例です。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ system-common プロジェクトの依存ライブラリについては、特に

<!-- textlint-enable ja-technical-writing/sentence-length -->

AlesInfiny Maia OSS Edition では、ロギングライブラリとして log4j 2 を使用します。
AlesInfiny Maia OSS Edition では、ロギングライブラリとして Apache Log4j 2 (以降 log4j2 )を使用します。
そのため、以下のようにデフォルトのロギングライブラリを依存関係から除外する設定を記述します。

``` groovy title="spring-boot-starter-logging の除外設定"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ web プロジェクトで利用を推奨するライブラリは以下の通り

- `spring-boot-starter-actuator`: ヘルスチェックを含めたアプリケーション監視・管理機能を構築するためのスターター

- `spring-boot-starter-log4j2`: Spring Boot アプリケーションで log4j 2 を使用するためのスターター
- `spring-boot-starter-log4j2`: Spring Boot アプリケーションで Apache Log4j 2 (以降 log4j2 )を使用するためのスターター

- `spring-boot-starter-test`:Spring Boot アプリケーションをテストするためのスターター

Expand Down Expand Up @@ -63,7 +63,7 @@ web プロジェクトの `src/main/resource` 以下に `application.properties`

- [Spring Boot のアプリケーションプロパティ設定一覧 :material-open-in-new:](https://spring.pleiades.io/spring-boot/docs/current/reference/html/application-properties.html){ target=_blank }
- [本番対応機能 :material-open-in-new:](https://spring.pleiades.io/spring-boot/docs/current/reference/html/actuator.html){ target=_blank }
- [myBatis-spring-boot-starter のアプリケーションプロパティ設定一覧 :material-open-in-new:](https://mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/){ target=_blank }
- [myBatis-spring-boot-starter のアプリケーションプロパティ設定一覧 :material-open-in-new:](https://mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/#configuration){ target=_blank }

設定項目は多岐に渡るため、一般的に設定する項目について例示します。

Expand Down Expand Up @@ -112,7 +112,7 @@ web プロジェクトの `src/main/resource` 以下に `application.properties`

<!-- textlint-enable ja-technical-writing/sentence-length -->

AlesInfiny Maia OSS Edition では、ロギングライブラリとして log4j 2 を使用します。
AlesInfiny Maia OSS Edition では、ロギングライブラリとして log4j2 を使用します。
そのため、以下のようにデフォルトのロギングライブラリを依存関係から除外する設定を記述します。

``` groovy title="spring-boot-starter-logging の除外設定"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,13 @@ description: Vue.js を用いた フロントエンドアプリケーション
<!-- textlint-disable ja-technical-writing/sentence-length -->

??? example "グローバルエラーハンドラーの実装例"

<!-- textlint-disable ja-technical-writing/sentence-length -->

Vue.js アプリケーションで発生したエラーに対するハンドリングは、 Vue.js で用意されている [app.config.errorHandler :material-open-in-new:](https://ja.vuejs.org/api/application#app-config-errorhandler){ target=_blank } に実装します。 JavaScript の構文エラーや、 Vue アプリケーション外の例外に対しては、[addEventListener() :material-open-in-new:](https://developer.mozilla.org/ja/docs/Web/API/EventTarget/addEventListener){ target=_blank } メソッドを用いてイベントリスナーを追加することでハンドリングします。同期処理については [error :material-open-in-new:](https://developer.mozilla.org/ja/docs/Web/API/Window/error_event){ target=_blank } イベントを検知することでハンドリングし、 API 通信や I/O 処理のような非同期処理については [unhandledrejection :material-open-in-new:](https://developer.mozilla.org/ja/docs/Web/API/Window/unhandledrejection_event){ target=_blank } イベントを検知することで、ハンドリングします。

<!-- textlint-enable ja-technical-writing/sentence-length -->

```ts title="global-error-handler.ts"
import type { App, ComponentPublicInstance } from 'vue';
import { router } from '../../router';
Expand Down
19 changes: 14 additions & 5 deletions samples/azure-ad-b2c-sample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,11 +213,20 @@ auth-frontend

### 動作確認

1. VS Code で `auth-backend` のフォルダーへ移動します。
1. VS Code のアクティビティーバーにある「Gradle」をクリックし、サイドバーの「 GRADLE PROJECTS 」タブから以下のタスクを実行します。
- web > Tasks > application > bootRun
1. VS Code で `auth-frontend` のフォルダーへ移動し、 `npm install` を実行します。
1. ターミナルで `npm run dev` を実行します。
1. VS Code で `auth-backend` のフォルダーへ移動し、ターミナルで以下を実行します。

```bash
./gradlew build
./gradlew web:bootRun
```

1. VS Code で `auth-frontend` のフォルダーへ移動し、ターミナルで以下を実行します。

```bash
npm ci
npm run dev:app
```

1. ブラウザーを開き、以下のアドレスにアクセスします。
- <http://localhost:5173>
1. 画面の「 `ログイン` 」をクリックします。 Azure AD B2C の `サインイン` 画面がポップアップで表示されます。
Expand Down

0 comments on commit f062c78

Please sign in to comment.