易鹏官方文档

Appearance

🚀 易鹏快捷开发框架使用指南 ​

项目下载 ​

📥 后端源码下载📥 下载后端代码

📥 前端源码下载🌐 下载前端代码

所需中间件及环境 ​

  • JDK 17/21       必须
  • Maven >= 3.6       必须
  • Nacos >=2.5.1       必须
  • Redis      必须
  • MinIO       必须(文件管理)、可替换成OBS
  • MySQL      可修改成其他数据库、默认MySQL >= 8.0
  • RabbitMQ      非必须、用于记录接口调用记录
  • XXL-JOB      非必须
  • Sentinel      非必须

初始化配置 ​

  1. 在 Nacos 管理界面新建一个命名空间
  2. 定位到源码中的 yipeng-auth 项目，进入其 resources 目录，找到名为 nacos_yipeng.zip 的配置压缩包，将压缩包导入至 Nacos 配置中心
  3. 创建数据库，库名 yipeng_auth，无需导入数据表，项目启动时会自动在库中生成表结构及初始化数据
  4. 在 Nacos 中修改 yipeng.core.yaml，把 Redis、RabbitMQ、MinIO 地址改成你自己的
yaml-redis
  data:
    redis:
      host: 127.0.0.1     # Redis服务器地址 
      port: 6379          # Redis服务器连接端口
      password: password    # Redis服务器连接密码（默认为空）
      database: 0         # Redis数据库索引（默认为0）
      timeout: 60s        # 连接空闲超过N(s秒、ms毫秒，不加单位时使用毫秒)后关闭，0为禁用，这里配置值和tcp-keepalive值一致
      lettuce:  # Lettuce连接池配置
        pool:
          max-active: 10  # 允许最大连接数，默认8（负值表示没有限制），推荐值：大于cpu * 2，通常为(cpu * 2) + 2   Lettuce 是多路复用（single connection, async），不像 Jedis 那样每个操作占一个连接。 通常 1～2 个物理连接就能支撑高并发
          max-idle: 8     # 最大空闲连接数，默认8，推荐值：cpu * 2
          min-idle: 2     # 最小空闲连接数，默认0
          max-wait: 5s    # 连接用完时，新的请求等待时间(s秒、ms毫秒)，超过该时间抛出异常，默认-1（负值表示没有限制）
  cache:
    type: redis                   # 指定缓存用Redis，开启缓存注解核心开关
yaml-rabbitmq
rabbitmq:
  host: 127.0.0.1 #修改IP地址
  port: 5672  #修改端口
  username: username #修改用户名
  password: password #修改密码
  virtual-host:
  publisher-returns: true
  publisher-confirm-type: correlated
yaml-minio
kp:
  minio:
    url: http://127.0.0.1:9000
    user-name: username
    password: password
  1. 在 Nacos 配置中心找到目标项目的配置文件 authentication（鉴权系统）、weekFlow（周汇通） ，把数据库链接改成你自己的 ，其中鉴权系统为核心依赖项必须修改，其他系统如暂不使用，可无需调整其配置文件，对应的代码模块也可一并删除以精简项目。
yaml-authentication
spring:
  application:
    name: authentication
  datasource:
    dynamic:
      primary: yipeng_auth
      strict: true
      datasource:
        yipeng_auth:
          url: jdbc:mysql://127.0.0.1:3306/yipeng_auth?useUnicode=true&autoReconnect=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&useSSL=false&zeroDateTimeBehavior=CONVERT_TO_NULL
          username: username
          password: password
          driver-class-name: com.mysql.cj.jdbc.Driver
      
kp:
  project-name: 鉴权项目 # 项目名称
yaml-weekFlow
spring:
  application:
    name: weekFlow
  datasource:
    dynamic:
      primary: yipeng_week_flow
      strict: true # 是否严格匹配数据源，默认为 false
      datasource:
        yipeng_week_flow:
          url: jdbc:mysql://127.0.0.1:3306/yipeng_week_flow?useUnicode=true&autoReconnect=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&useSSL=false&zeroDateTimeBehavior=CONVERT_TO_NULL
          username: username
          password: password
          driver-class-name: com.mysql.cj.jdbc.Driver

kp:
  project-name: 周汇通 # 项目名称
  1. 启动系统
  • 网关：修改网关代码 yipeng-gateway 中 resources 里面 bootstrap-dev.yml 文件，把 Nacos 地址改成你自己的
  • 鉴权服务：修改鉴权代码 yipeng-auth 中 resources 里面 bootstrap-dev.yml 文件，把 Nacos 地址改成你自己的
  • 如需启动其他系统，请按照上述步骤找到对应配置文件完成对应操作，然后启动项目即可

⚠️ 开发建议：开发阶段可暂不启动网关系统，仅需启动目标开发系统，前端可直接调用对应服务接口。待部署至生产环境时，再通过统一网关进行服务调度，避免开发过程中的不必要复杂性。

yaml-网关(yipeng-gateway)
spring:
  cloud:
    nacos:
      username: username #修改用户名
      password: password #修改密码
      discovery:
        server-addr: http://127.0.0.1:8848 #修改IP地址
        namespace: b502bb03-dd78-4078-8934-111111111 # 修改命名空间
      config:
        server-addr: http://127.0.0.1:8848 #修改IP地址
        namespace: b502bb03-dd78-4078-8934-111111111 # 修改命名空间
        group: DEFAULT_GROUP
        file-extension: yaml
        prefix: gateway
        
# --------------以下配置只在本地开发环境加   部署服务时务必删除 ----------------------
logging:
  level:
    org.springframework.cloud.gateway: TRACE
    org.springframework.cloud.loadbalancer: DEBUG
    com.github.xiaoymin.knife4j.gateway: DEBUG
    com.github.xiaoymin.knife4j.core: DEBUG

log:
  path: ./logs/gateway   # 相对路径：文件夹不存在自动创建
# ----------------------------------------------------------------------------------
yaml-鉴权系统(yipeng-auth)
spring:
  cloud:
    nacos:
      username: username #修改用户名
      password: password #修改密码
      discovery:
        server-addr: http://127.0.0.1:8848 #修改IP地址
        namespace: b502bb03-dd78-4078-8934-111111111 # 修改命名空间
      config:
        server-addr: http://127.0.0.1:8848 #修改IP地址
        namespace: b502bb03-dd78-4078-8934-111111111 # 修改命名空间
        group: DEFAULT_GROUP
        file-extension: yaml
        prefix: authentication
        extension-configs:
          - data-id: yipeng.core.yaml
            group: DEFAULT_GROUP
            refresh: true

# --------------以下配置只在本地开发环境加   部署服务时务必删除 ----------------------
logging:
  level:
    feign.client: DEBUG
    com.kp.framework.modules: DEBUG

log:
  path: ./logs/auth   # 相对路径：文件夹不存在自动创建
# ----------------------------------------------------------------------------------
  1. 启动前端代码：下载前端代码，然后启动，具体操作请参考前端文档

恭喜您，易鹏系统已经搭建完成，现在开始体验吧！

更多使用指南 ​

想要深入了解其他用户的实际应用案例和最佳实践经验？欢迎查阅社区精心整理的详细使用总结文档👇

📄 查看社区使用总结

切换其他数据源 ​

易鹏框架原生支持多类型数据库适配，包括 MySQL、Oracle、SQL Server、PostgreSQL 等； 其中开源系统（鉴权系统、周汇通）当前已完成 MySQL、PostgreSQL 两种数据库的适配。

鉴权系统、周汇通默认使用 MySQL 作为数据源，若需切换至 PostgreSQL，仅需修改 Nacos 配置文件 yipeng.core.yaml 中 flyway.locations 配置项： 将原配置值 classpath:db 替换为 classpath:pgsql 即可，完整配置示例如下：

yaml
  flyway:
    enabled: true # 是否开启 Flyway
    encoding: UTF-8 
    locations: classpath:pgsql # 设置 Flyway 的 SQL 文件位置
    baseline-on-migrate: true 
    sql-migration-prefix: V 
    sql-migration-separator: 
    sql-migration-suffixes: sql 
    validate-on-migrate: true 
    fail-on-missing-locations: false 
    clean-disabled: true

在对应项目配置文件下，把数据源改成 PostgreSQL，完整配置示例如下：

yaml
spring:
  datasource:
    dynamic:
      primary: yipeng_auth
      strict: true
      datasource:
        yipeng_auth:
          url: jdbc:postgresql://127.0.0.7:5432/yipeng_auth_dev?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
          username: username
          password: password
          driver-class-name: org.postgresql.Driver
💡 提示： 如需适配其他数据库（如 Oracle、SQL Server），可基于易鹏框架进行扩展开发，或关注官方后续版本更新。