# cc-spring

**Repository Path**: cc4414/cc-spring

## Basic Information

- **Project Name**: cc-spring
- **Description**: cc-spring是一套基于spring的快速开发框架。它提供了一系列可插拔的模块，你可以利用它快速构建一个单体应用或者一个微服务应用。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://cc4414.gitee.io/cc-spring-doc
- **GVP Project**: No

## Statistics

- **Stars**: 9
- **Forks**: 3
- **Created**: 2019-10-06
- **Last Updated**: 2025-04-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cc-spring

![Maven Central](https://img.shields.io/maven-central/v/cc.cc4414/cc-spring-boot-starter-parent)
![GitHub](https://img.shields.io/github/license/cc4414/cc-spring)
![GitHub repo size](https://img.shields.io/github/repo-size/cc4414/cc-spring)

## 简介

cc-spring是一套基于spring的快速开发框架。它提供了一系列可插拔的模块，你可以利用它快速构建一个单体应用或者一个微服务应用。

cc-spring的各个模块分别整合了spring boot、spring cloud alibaba、mybatis plus、hutool等优秀的开源框架。

## 文档

[详细文档](https://cc4414.gitee.io/cc-spring-doc)

## 快速开始

该框架基于spring boot，所以在一个新建的spring boot工程里面进行如下操作

1. 在 dependencyManagement 中添加如下配置

``` xml
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>cc.cc4414</groupId>
            <artifactId>cc-spring-boot-starter-parent</artifactId>
            <version>latest</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
```

2. 引入依赖

``` xml
<dependency>
    <groupId>cc.cc4414</groupId>
    <artifactId>cc-spring-web-starter</artifactId>
</dependency>
```

3. controller层方法

``` java
@RestController
public class QuickstartController {
    @GetMapping("test")
    @ResultAnnotation
    public Integer test(int i) {
        return i;
    }
}
```

4. 启动项目

spring boot项目启动

5. 使用

项目启动完成后，访问[http://127.0.0.1:8080/swagger-ui.html](http://127.0.0.1:8080/swagger-ui.html)打开swagger页面<br>
测试刚刚写的test方法，可以用swagger测试，也可以直接访问[http://127.0.0.1:8080/test?i=1](http://127.0.0.1:8080/test?i=1)<br>
得到如下结果：

``` js
{
  "code": "0",
  "message": "成功",
  "data": 1,
  "success": true
}
```

将参数i=1去掉，得到如下结果：

``` js
{
  "code": "1",
  "message": "未知错误",
  "data": "xxx",
  "success": false
}
```

6. 小结

仅仅引入了一个依赖，就集成了swagger，对异常结果也进行了处理，并且仅通过一个简单的注解@ResultAnnotation，使得返回的结果有统一的报文格式。<br>
还有分布式锁、重试、异常通知等功能，也可以仅仅通过一个注解方便的实现。<br>
其他模块还有更多强大的功能等着你来尝试，请看[详细教程](https://cc4414.gitee.io/cc-spring-doc)。<br>
单体应用的完整demo请看[cc-spring-demo-monolith](https://gitee.com/cc4414/cc-spring/tree/master/cc-spring-demo/cc-spring-demo-monolith)。

## 项目结构

``` lua
cc-spring
├── cc-spring-boot-starter-parent
│   ├── cc-spring-boot-starter -- 通用的功能
│   ├── cc-spring-cloud-starter -- spring cloud的常用组件整合
│   ├── cc-spring-cloud-starter-gateway -- 网关
│   ├── cc-spring-web -- controller层统一处理及整合swagger
│   │   ├── cc-spring-web-core
│   │   └── cc-spring-web-starter
│   ├── cc-spring-mybatis -- mybatis-plus的自动填充以及冗余字段更新
│   │   ├── cc-spring-mybatis-core
│   │   └── cc-spring-mybatis-starter
│   ├── cc-spring-resource -- 资源服务器
│   │   ├── cc-spring-resource-core
│   │   └── cc-spring-resource-starter
│   ├── cc-spring-auth -- 认证服务器
│   │   ├── cc-spring-auth-client
│   │   └── cc-spring-auth-server
│   ├── cc-spring-sys -- 系统管理
│   │   ├── cc-spring-sys-client
│   │   └── cc-spring-sys-server
│   └── cc-spring-xxx -- 其他
├── cc-spring-demo -- 使用样例
└── web -- 前端页面
```

## 核心模块

- [cc-spring-boot-starter](https://cc4414.gitee.io/cc-spring-doc/guide/cc-spring-boot-starter.html)
- [cc-spring-web](https://cc4414.gitee.io/cc-spring-doc/guide/cc-spring-web.html)
- [cc-spring-mybatis](https://cc4414.gitee.io/cc-spring-doc/guide/cc-spring-mybatis.html)
- [cc-spring-sys](https://cc4414.gitee.io/cc-spring-doc/guide/cc-spring-sys.html)
- [cc-spring-resource](https://cc4414.gitee.io/cc-spring-doc/guide/cc-spring-resource.html)
- [cc-spring-auth](https://cc4414.gitee.io/cc-spring-doc/guide/cc-spring-auth.html)
- [cc-spring-cloud-starter-gateway](https://cc4414.gitee.io/cc-spring-doc/guide/cc-spring-cloud-starter-gateway.html)