跳至主要內容

本地开发环境配置

Ryan SU大约 5 分钟

环境需求

  • golang 1.20 +
  • nodejs 19.8.0 +
  • mysql 8.0.30 + | MariaDB 10.7 + | Postgres 13 + (Postgres 14 推荐)
  • redis 7.0 +
  • go-swagger
  • Goctls

相关信息

建议使用 PostgreSQL 数据库

推荐在 linux 下开发，因为需要用到 make 命令
Windows 用户建议自行配置环境， 参考 Windows， 或者在 WSL 环境下开发

相关信息

视频教程 Backend UI 文档

A BiliBili video

后端部署

注意

除非要二次开发 core 服务， 否则建议直接接入官方镜像， 参考教程 直接接入 Core 服务

A BiliBili video

simple admin core

simple admin core 是核心代码，主要负责用户注册鉴权和充当网关的角色以及后台的各类配置。

默认账号

username: admin
password: simple-admin

下载代码

git clone https://github.com/suyuan32/simple-admin-core.git

本地调试配置

API 服务

注意本地测试最好创建 core_dev.yaml 与部署文件 core.yaml 区分开

添加 api/etc/core_dev.yaml

Name: core.api
Host: 0.0.0.0 # ip可以是0.0.0.0也可以是127.0.0.1,如需其他外部主机访问则需要为 0.0.0.0
Port: 9100
Timeout: 30000

Auth:
  AccessSecret: jS6VKDtsJf3z1n2VKDtsJf3z1n2 # JWT的加密密钥，各个API应保持一致才能解析
  AccessExpire: 259200 # 秒，过期时间

# 跨域配置
CROSConf:
  Address: '*'

Log:
  ServiceName: coreApiLogger
  Mode: file
  Path: /home/ryan/logs/core/api # log 保存路径，使用filebeat同步
  Level: info
  Compress: false
  KeepDays: 7 # 保存时长（天）
  StackCoolDownMillis: 100

RedisConf:
  Host: 127.0.0.1:6379 # 改成自己的redis地址
  Type: node
  # Pass: xxx  # 也可以设置密码

# 与 k8s 主要是此处服务发现不同
# 核心模块
CoreRpc:
  Endpoints:
    - 127.0.0.1:9101 # 与 Core RPC 地址相同
  Enabled: true # 是否启用

# 定时任务模块
JobRpc:
  Endpoints:
    - 127.0.0.1:9105 # 与 Job RPC 地址相同
  Enabled: false # 是否启用

# 消息中心模块
McmsRpc:
  Endpoints:
    - 127.0.0.1:9106 # 与 Mcms RPC 地址相同
  Enabled: true # 是否启用
  Timeout: 5000

Captcha:
  KeyLong: 5 # 验证码长度
  ImgWidth: 240 # 验证码图片宽度
  ImgHeight: 80 # 验证码图片高度
  Driver: digit # 支持四种驱动 digit, string, math, chinese 默认为 digit

DatabaseConf:
  Type: mysql # 支持 mysql, postgres, sqlite3
  Host: "127.0.0.1" # 修改成自己的mysql地址
  Port: 3306
  DBName: simple_admin # 数据库名称
  Username: root # 用户名
  Password: "123456" # 密码
  MaxOpenConn: 100 # 最大连接数
  SSLMode: disable # 是否在 postgresql 中使用 SSL, disable 或 require
# DBPath: /home/data/sqlite.db # Sqlite 数据库文件存放位置，使用 sqlite3时必须设置
# MysqlConfig: '&charset=utf8&loc=Asia/Shanghai' # Mysql的额外配置
# PGConfig: ''  # Postgresql 的额外配置
# SqliteConfig: '' # Sqlite 的额外配置

# casbin 规则
CasbinConf:
  ModelText: |
    [request_definition]
    r = sub, obj, act
    [policy_definition]
    p = sub, obj, act
    [role_definition]
    g = _, _
    [policy_effect]
    e = some(where (p.eft == allow))
    [matchers]
    m = r.sub == p.sub && keyMatch2(r.obj,p.obj) && r.act == p.act

I18nConf:
  Dir: # I18n 文件的外部路径，若不为空则会读取外部，若为空则读取二进制文件内部的i18n文件

ProjectConf:
  DefaultRole: 1 # 注册用户默认的角色ID
  DefaultDepartment: 1 # 注册用户默认的部门 ID
  DefaultPosition: 1 # 注册用户默认的职位 ID
  EmailCaptchaExpiredTime: 600 # 默认电子邮件超时时间
  SmsTemplateId: xxx # 默认短信模板ID
  SmsAppId: xxx # 默认短信 APP ID
  SmsSignName: xxx # 默认短信签名
  RegisterVerify: captcha # 注册验证方式，支持 captcha, email, sms, sms_or_email
  LoginVerify: captcha #  登录验证方式，支持 captcha, email, sms, sms_or_email, all
  ResetVerify: email # 重置验证方式，支持  email, sms, sms_or_email
  AllowInit: true # 若为 false ，禁止初始化数据库

注意

小型网站直接使用

CoreRpc:
  Endpoints:
    - 127.0.0.1:9101 # the same as rpc address
  Enabled: true

的方式直连，不需要服务发现，本地调试也是使用直连的方式， Endpoints 可以有多个

添加 rpc/etc/core_dev.yaml

Name: core.rpc
ListenOn: 0.0.0.0:9101 # ip可以是0.0.0.0也可以是127.0.0.1,如需其他外部主机访问则需要为 0.0.0.0

DatabaseConf:
  Type: mysql # 支持 mysql, postgres, sqlite3
  Host: "127.0.0.1" # 修改成自己的mysql地址
  Port: 3306
  DBName: simple_admin # 数据库名称
  Username: root # 用户名
  Password: "123456" # 密码
  MaxOpenConn: 100 # 最大连接数
  SSLMode: disable # 是否在 postgresql 中使用 SSL, disable 或 require
# DBPath: /home/data/sqlite.db # Sqlite 数据库文件存放位置，使用 sqlite3时必须设置
# MysqlConfig: '&charset=utf8&loc=Asia/Shanghai' # Mysql的额外配置
# PGConfig: ''  # Postgresql 的额外配置
# SqliteConfig: '' # Sqlite 的额外配置

# casbin 规则
CasbinConf:
  ModelText: |
    [request_definition]
    r = sub, obj, act
    [policy_definition]
    p = sub, obj, act
    [role_definition]
    g = _, _
    [policy_effect]
    e = some(where (p.eft == allow))
    [matchers]
    m = r.sub == p.sub && keyMatch2(r.obj,p.obj) && r.act == p.act

Log:
  ServiceName: coreRpcLogger
  Mode: file
  Path: /home/ryan/logs/core/rpc # log 保存路径，使用filebeat同步
  Encoding: json
  Level: info
  Compress: false
  KeepDays: 7 # 保存时长（天）
  StackCoolDownMillis: 100

RedisConf:
  Host: 192.168.50.216:6379 # 改成自己的redis地址
  Type: node
  # Pass: xxx  # 也可以设置密码

配置依赖

go mod tidy

运行 rpc 服务

cd rpc

go run core.go -f etc/core_dev.yaml

运行 api 服务

cd api

go run core.go -f etc/core_dev.yaml

前端配置

下载代码

git clone https://github.com/suyuan32/simple-admin-backend-ui.git

下载依赖

pnpm install

注意

如果下载依赖失败，请升级 pnpm 至最新版

运行

pnpm serve

编译

pnpm build

预览

# 编译后再预览
pnpm preview

# 直接预览dist文件夹，不重复编译
pnpm preview:dist

注意 配置后端 API 地址

.env.development

# Whether to open mock
VITE_USE_MOCK = false

# public path
VITE_PUBLIC_PATH = /

VITE_BUILD_COMPRESS = 'none'

# Delete console
VITE_DROP_CONSOLE = false

# Basic interface address SPA
VITE_GLOB_API_URL=

# File upload address， optional
VITE_GLOB_UPLOAD_URL=/fms-api/upload

# Interface prefix
VITE_GLOB_API_URL_PREFIX=

从 1..0.0 开始 backend UI 的代理配置放在 vite.config.ts 文件中

import { defineApplicationConfig } from "@vben/vite-config";

export default defineApplicationConfig({
  overrides: {
    optimizeDeps: {
      include: [
        "echarts/core",
        "echarts/charts",
        "echarts/components",
        "echarts/renderers",
        "qrcode",
        "@iconify/iconify",
        "ant-design-vue/es/locale/zh_CN",
        "ant-design-vue/es/locale/en_US",
      ],
    },
    server: {
      proxy: {
        "/sys-api": {
          target: "http://192.168.50.204:9100",
          changeOrigin: true,
          ws: true,
          rewrite: (path) => path.replace(new RegExp(`^/sys-api`), ""),
          // only https
          // secure: false
        },
        "/fms-api": {
          target: "http://192.168.50.204:9102",
          changeOrigin: true,
          ws: true,
          rewrite: (path) => path.replace(new RegExp(`^/fms-api`), ""),
        },
        "/mms-api": {
          target: "http://192.168.50.204:9104",
          changeOrigin: true,
          ws: true,
          rewrite: (path) => path.replace(new RegExp(`^/mms-api`), ""),
        },
      },
    },
  },
});

本地调试需要自行配置 target 地址以及 rewrite

初始化数据库

注意

重要: 在初始化数据库前必须先创建数据库, 数据库名称和配置文件中的名称相同.

# 访问前端地址端口
https://address:port/init

# 默认
https://localhost:3100/init

进入界面

pic
pic

文件服务初始化是可选的，没有运行文件 api 可以不初始化