Vue.js OIDC Client 项目教程

1. 项目目录结构及介绍

vuejsOidcClient/
├── public/
│   ├── index.html
│   └── ...
├── src/
│   ├── assets/
│   ├── components/
│   ├── router/
│   ├── store/
│   ├── views/
│   ├── App.vue
│   ├── main.js
│   └── ...
├── .env
├── .gitignore
├── package.json
├── README.md
└── ...

目录结构介绍

• public/: 存放静态资源文件，如 index.html，这些文件不会被 Webpack 处理。
• src/: 项目的源代码目录。
  • assets/: 存放静态资源文件，如图片、字体等。
  • components/: 存放 Vue 组件文件。
  • router/: 存放 Vue Router 相关配置文件。
  • store/: 存放 Vuex 状态管理相关文件。
  • views/: 存放页面级别的 Vue 组件。
  • App.vue: 项目的根组件。
  • main.js: 项目的入口文件。
• .env: 环境变量配置文件。
• .gitignore: Git 忽略文件配置。
• package.json: 项目的依赖管理文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

main.js

main.js 是 Vue.js 项目的入口文件，负责初始化 Vue 实例并挂载到 DOM 上。以下是 main.js 的主要内容：

import Vue from 'vue';
import App from './App.vue';
import router from './router';
import store from './store';

Vue.config.productionTip = false;

new Vue({
  router,
  store,
  render: h => h(App),
}).$mount('#app');

文件介绍

• Vue.config.productionTip: 设置为 false 以关闭生产环境下的提示信息。
• new Vue({...}): 创建 Vue 实例，并传入 router 和 store 配置。
• render: h => h(App): 使用 App.vue 作为根组件进行渲染。
• $mount('#app'): 将 Vue 实例挂载到 index.html 中的 #app 元素上。

3. 项目的配置文件介绍

.env

.env 文件用于配置项目的环境变量。以下是一个示例：

VUE_APP_API_URL=https://api.example.com
VUE_APP_OIDC_AUTHORITY=https://auth.example.com
VUE_APP_OIDC_CLIENT_ID=your-client-id
VUE_APP_OIDC_REDIRECT_URI=http://localhost:8080/callback

配置项介绍

• VUE_APP_API_URL: API 服务器的 URL。
• VUE_APP_OIDC_AUTHORITY: OIDC 认证服务器的 URL。
• VUE_APP_OIDC_CLIENT_ID: OIDC 客户端 ID。
• VUE_APP_OIDC_REDIRECT_URI: OIDC 认证成功后的重定向 URL。

package.json

package.json 文件用于管理项目的依赖和脚本命令。以下是一些关键配置：

{
  "name": "vuejs-oidc-client",
  "version": "1.0.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "vue": "^2.6.11",
    "vue-router": "^3.2.0",
    "vuex": "^3.4.0",
    "oidc-client": "^1.10.1"
  },
  "devDependencies": {
    "@vue/cli-service": "~4.5.0",
    "vue-template-compiler": "^2.6.11"
  }
}

配置项介绍

• scripts: 定义了项目的脚本命令，如 serve、build 和 lint。
• dependencies: 项目的生产依赖，如 vue、vue-router、vuex 和 oidc-client。
• devDependencies: 项目的开发依赖，如 @vue/cli-service 和 vue-template-compiler。

通过以上配置，项目可以正常启动并使用 OIDC 进行身份验证。