/Memory-Core

这里是Memory Blog的后端仓库

Primary LanguageJava

Memory-Core

这里是Memory Blog的后端仓库

项目结构

Memory-Core
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── memory
│   │   │           └── blog
│   │   │               ├── aspect 切面
│   │   │               ├── config 配置
│   │   │               ├── controller 控制器 
│   │   │               ├── dao 数据访问层 ，和 mapper 冲突
│   │   │               ├── entity 实体类 
│   │   │               ├── enums 枚举
│   │   │               ├── exception 异常,TODO
│   │   │               ├── interceptor 拦截器
│   │   │               ├── mapper mapper接口
│   │   │               ├── service 
│   │   │               ├── utils
│   │   │               └── ServerApplication.java 启动类
│   │   └── resources
│   │       ├── com.linmoblog.server.mapper mapper文件
│   │       ├── db-init 数据库初始化文件
│   │       ├── MATE-INF 
│   │       ├── application.yml 通用配置
│   │       ├── application-dev.yml 开发环境配置
│   │       ├── application-prod.yml 生产环境配置
│   │       └── logback-spring.xml

使用

cd && mkdir -p Memory/core && cd $_
mkdir -p db_init
wget -O db_init/init.sql https://cdn.jsdelivr.net/gh/LinMoQC/Memory-Core@master/db_init/init.sql
wget https://cdn.jsdelivr.net/gh/LinMoQC/Memory-Core@master/docker-compose.yml
docker-compose up -d

初始账号：
admin
123456

增加 sys_config 表保存配置信息

在 application.yml 中的配置可以写到 sys_config 表中（除了数据库配置，一般用于存储业务配置），这样可以在数据库或者后台管理界面修改项目配置（TODO）。 config_key 对应配置的 key，config_value 对应配置的 value。

文件存储

文件存储目前继承了本地文件存储、阿里云 OSS 文件存储，后续会扩展更多的文件存储方式（Github、Gitee） 同时只支持一种文件存储方式，如果配置了多种文件存储方式，则会有报错提示。

说人话就是 ali.enable 和 local.enable 只能有一个为 true。

阿里云 OSS 文件存储

在 application.yml 中修改配置

ali:
  enable: true # 是否启用阿里云 OSS 文件存储
  endpoint: xxx # OSS endpoint 
  accessKeyId: xxx # OSS accessKeyId
  accessKey: xxx # OSS accessKey
  bucketName: xxx # OSS bucketName
  uploadPath: xxx # OSS uploadPath

本地文件存储

在 application.yml 中修改配置

local:
  enable: true # 是否启用本地文件存储
  uploadDir: xxx # 本地文件存储路径, 例如：/usr/local/upload 或 upload-dir 。

一些规范

异常体系

  1. 在 Service 层不推荐使用直接返回 Result 对象的方法，最佳方式是抛出 CommonException 异常，GlobalExceptionHandler.java 中会统一拦截 CommonException 异常，并将其转换为包含错误信息的 Result 对象返回。
  2. 在 Controller 层使用 Result 对象直接返回。

具体示例参照 ImageController

环境搭建

minio搭建

推荐使用 docker 进行安装。 命令如下：

# 创建文件夹
mkdir /home/minio
cd /home/minio
mkdir data 
mkdir config

# 运行容器
docker run --name minio \
-p 9000:9000 \
-p 9999:9999 \
-d --restart=always \
-e "MINIO_ROOT_USER=memory" \
-e "MINIO_ROOT_PASSWORD=memory" \
-v /home/minio/data:/data \
-v /home/minio/config:/root/.minio \
minio/minio server /data \
--console-address '0.0.0.0:9999'