# robin

**Repository Path**: opensource4clive/robin

## Basic Information

- **Project Name**: robin
- **Description**: robin是一个基于MyBatis提供增删改查功能的轻量级框架。
Robin is a lightweight framework based on MyBatis that provides adding, deleting, modifying and checking capabilities
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2020-12-23
- **Last Updated**: 2022-07-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Robin

## 介绍
`Robin`是一个基于`MyBatis`框架, 提供基础的增删改查增强功能的轻量级框架。<br>
Robin is a lightweight framework based on MyBatis that provides adding, deleting, modifying and querying capabilities

## 项目背景
此项目参考了[mybatis-generator](http://mybatis.org/generator/)和[mybatis-plus](https://mybatis.plus/)。mybatis-generator会生成很多冗余代码，而mybatis-plus则不用生成冗余代码，功能也很强大，但是其对底层侵入太深，对mybatis的SqlSessionFactory进行了重写，不能直接集成到现有项目中使用；参考两者优秀之处`Robin诞生了，既不生成冗余代码，也不会对底层进行侵入，使用方便集成快速，适合快速开发，让coder将更多的时间用在业务逻辑上。

### 此项目提供2个核心功能
- 基础CRUD
- 代码生成

### 基础CRUD `robin-base`
通用Mapper和Service提供CRUD基本操作的支持 (`BaseMapper`, `BaseService` )
### 代码生成 `robin-generator`
提供代码生成功能，在表结构变动时可高效快速生成对应的实体对象


## 特性
- **无侵入**：轻量级，只做增强不做改变，引入它不会对现有工程产生影响
- **无损耗**：启动即会自动注入基本增删改查功能，性能无损耗，直接面向对象操作
- **CRUD 操作**：内置BaseMapper、BaseService，无需任何配置直接继承 CRUD 操作
- **支持 Lambda 形式调用**：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
- **代码生成器**：可快速生成 Entity、Mapper、Service、Controller 层代码，支持自定义模板
- **分页**：基于 MyBatis 物理分页，直接返回grus框架封装的分页对象, 同时也支持pagehelper分页插件


## 软件架构
```
project                             项目根目录 
├─robin-base                        基础
├─robin-generator                   代码生成
├─doc                               文档
└─
```

## 安装教程
最新版本`last.version`=   <a href="https://search.maven.org/search?q=com.gitee.opensource4clive%20AND%20robin">
          <img alt="maven" src="https://img.shields.io/maven-central/v/com.gitee.opensource4clive/robin.svg?style=flat-square">
        </a>
### MyBatis版本要求
`mybatis.version ≥ 3.5.6`

### 如仅需要增删改查的增强功能
>仅依赖robin-base项目即可
```xml
<dependency>
    <groupId>com.gitee.opensource4clive</groupId>
    <artifactId>robin-base</artifactId>
    <version>${last.version}</version>
</dependency>
```
### 如需要增删改查的增强功能和代码生成功能
>依赖robin-base和robin-generator 其中 robin-generator的scrop建议设置为**test**
```xml
<dependency>
    <groupId>com.gitee.opensource4clive</groupId>
    <artifactId>robin-generator</artifactId>
    <version>${last.version}</version>
    <scope>test</scope>
</dependency>
```

## 项目文档

### [快速开始](doc/fast-start.md)

### [CRUD 接口](doc/crud-interface.md)

### [条件构造器](doc/conditional.md)

### [代码生成器](doc/generator.md)

### [常见问题](doc/faq.md)

### [示例项目](https://gitee.com/opensource4clive/robin-example)

### [更新日志](doc/release-log.md)