# siri-frame

**Repository Path**: bearhm/siri-frame

## Basic Information

- **Project Name**: siri-frame
- **Description**: lsr脚手架
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-05-11
- **Last Updated**: 2024-05-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 项目简介

siri-frame，siri是取自本人作者的名字以及ios的手机助手的siri想法而来

一直想做一款适用于中小项目的轻量级快速开发框架，涵盖平时业务开发的常用场景，做到开箱即用。用户可以根据自身情况选择组件来进行使用，采取组件化开发模式。

比如用户需要redis，则选择redis组件，需要websocket，则引入websocket组件，用户自身不需要再开发什么，只需要按照组件规则进行使用即可。各种配置类已经集成，也有自定义的可插拔式的插件供使用。

项目整体采用maven结构开发，封装了大量的模块，彼此解耦。满足用户日常开发需要。



## 项目模块结构介绍

###  siri-common

- siri-common-job：分布式任务调度组件
- siri-common-log：日志组件，提供日志切面自动记录及异步日志提升性能
- siri-common-mybatisplus：采用Mybatisplus作为与数据库交互
- siri-common-redis：缓存组件，提供基于redis的操作封装，redis分布式锁，guava的cache工具类
- siri-common-starter：启动类组件，与启动类相关的功能，放到此组件处，目前包含mongoStarter
- siri-common-swagger：swagger组件，提供整体项目访问api的入口及方法文档
- siri-common-test：测试组件，集成springboot-test，及代码单元测试，代码覆盖率，行覆盖率检测
- siri-common-tool：常用的工具类组件，满足业务日常开发的各种需要，保障安全性，低入侵性
- siri-common-web：web组件，提供统一异常处理，web模块转换，统一返回值
- siri-common-websocket：websocket组件，提供一套带鉴权的websocket，引入即用，简单方便
- siri-mail：邮件发送组件

###  siri-dependencies

该模块为一个父pom模块，提供项目整体的maven包的锁定及规范，统一升级，统一引入。



## 如何快速使用本框架

- 将框架代码 git clone 到本地或者将框架代码直接download下来使用

新建一个文件夹，进入该文件夹终端，输入git clone https://gitee.com/li-siri/siri-frame.git 

用Idea直接打开，选择Trust Project即可，打开项目后你会看到如下的目录结构

![image-20240422122603972](https://spice-1318337912.cos.ap-guangzhou.myqcloud.com/fruitsvegetables/1.jpg)

然后开始新建你自己的项目的Module

![image-20240506163600079](https://spice-1318337912.cos.ap-guangzhou.myqcloud.com/fruitsvegetables/image-20240506163600079.png)

![image-20240506163719069](https://spice-1318337912.cos.ap-guangzhou.myqcloud.com/fruitsvegetables/image-20240506163719069.png)

随后在你自己创建的Maven项目中建立如下包结构

![image-20240422123442729](https://spice-1318337912.cos.ap-guangzhou.myqcloud.com/fruitsvegetables/image-20240422123442729.png)

在pom.xml中引入我们的Web模块

```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.siriframe.demo</groupId>
    <artifactId>siri-frame-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.plugin.version>3.1</maven.plugin.version>
        <maven.compile.source>1.8</maven.compile.source>
        <maven.compile.target>1.8</maven.compile.target>
        <siri.common.version>0.0.1-SNAPSHOT</siri.common.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.siriframe</groupId>
            <artifactId>siri-common-web</artifactId>
            <version>${siri.common.version}</version>
        </dependency>
    </dependencies>

</project>
```

随后创建启动类，建立application.yml文件后，即可开启本框架使用

![image-20240422125526756](https://spice-1318337912.cos.ap-guangzhou.myqcloud.com/fruitsvegetables/image-20240422125526756.png)

```yml
server:
  port: 8081
```