# 简介

![lodsve-framework](https://raw.githubusercontent.com/lodsve/lodsve-documents/master/images/logo.png)

[![Build Status](https://travis-ci.org/lodsve/lodsve-framework.svg?branch=master)](https://travis-ci.org/lodsve/lodsve-framework) [![License](https://img.shields.io/badge/license-GPLv3-yellowgreen.svg)](https://helps.lodsve.com/master) [![Maven Central](https://img.shields.io/maven-central/v/com.lodsve/lodsve-framework.svg)](https://search.maven.org/artifact/com.lodsve/lodsve-framework) [![GitHub stars](https://img.shields.io/github/stars/lodsve/lodsve-framework.svg)](https://github.com/lodsve/lodsve-framework/stargazers) [![GitHub forks](https://img.shields.io/github/forks/lodsve/lodsve-framework.svg)](https://github.com/lodsve/lodsve-framework/network) [![GitHub issues](https://img.shields.io/github/issues/lodsve/lodsve-framework.svg)](https://github.com/lodsve/lodsve-framework/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/lodsve/lodsve-framework.svg)](https://github.com/lodsve/lodsve-framework/pulls) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Flodsve%2Flodsve-framework.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Flodsve%2Flodsve-framework?ref=badge_shield)

## lodsve-framework

My development tools, it encapsulates some open source projects, and better facilitate the conduct of Java Web development.

## What is `lodsve`

`lodsve` is the short of `Let our development of Spring very easy!`.

## Simple Introduction

1. Base on some open source framework. It encapsulates some classes and methods to make more convenient for developers.
2. It consists of the following modules:
   * lodsve-3rd
   * lodsve-cache
   * lodsve-core
   * lodsve-dfs
   * lodsve-framework-bom
   * lodsve-mongodb
   * lodsve-mybatis
   * lodsve-rabbitmq
   * lodsve-rdbms
   * lodsve-redis
   * lodsve-rocketmq
   * lodsve-search
   * lodsve-security
   * lodsve-test
   * lodsve-validate
   * lodsve-web
   * lodsve-wechat

## How To Use

com.lodsvelodsve-framework-bom${lodsve.version}pomimport

## About release

Version No. like `MAJOR.MINOR.PATCH-RELEASE/ALPHA/BETA`.

* `MAJOR` version when I make incompatible API changes,
* `MINOR` version when I add functionality in a backwards-compatible manner, and
* `PATCH` version when I make backwards-compatible bug fixes.
* `RELEASE` means a stable release version.
* `ALPHA` means internal version.
* `BETA` means just for testing.    

## Newest version

Now the newest and stable version is `2.7.1-RELEASE`.

You can also find the newest version in maven central: `http://repo1.maven.org/maven2/com/lodsve/lodsve-framework/`.

## Documentation

See the current [reference docs](https://helps.lodsve.com/).

See the master branch [Api Docs](https://apidoc.gitee.com/lodsve/lodsve-framework/).

## Check out sources

`git clone git@github.com:lodsve/lodsve-framework.git`

## Check out demos

`git clone git@github.com:lodsve/lodsve-demo.git`

## Check out the configurations

`cd lodsve-core/src/main/resources/META-INF/config-template`

## Import sources into your IDE

Run command `mvn idea:idea` or `mvn eclipse:eclipse` in the root folder.

> **Note:** Per the prerequisites above, ensure that you have `JDK 8` and `Maven 3.3.X` and `Lombok Plugin` configured properly in your IDE.

1. Config your Git

   ```
    git config --global user.name "your name"
    git config --global user.email "your email"
    git config --global core.autocrlf false
    git config --global core.safecrlf true
   ```
2. Config your IDE
   * Eclipse: Open Settings-General-Workspace, modify `New text file line delimiter` as `Unix`
   * Eclipse: Open Settings-General-Workspace, modify `Text file encoding` as `UTF-8`
   * IDE: Open Setting-Editor-Code Style, modify `line delimiter` as `Unix and OS X(\n)`
   * IDE: Open Setting-Editor-File encoding, modify all `Encoding` as `UTF-8` and `with NO BOM`
3. Required IDE Plugins(Both Eclipse and Intellij IDEA):
   * Alibaba Java Coding Guidelines
   * Lombok plugin    

## Change History

[CHANGELOG](https://github.com/lodsve/lodsve-framework/blob/master/CHANGELOG.md)

## Contact me

1. Email: <sunhao.java@gmail.com>
2. QQ: [867885140](http://wpa.qq.com/msgrd?v=3\&uin=867885140\&site=qq\&menu=yes)
3. Blog: [Blog](https://www.crazy-coder.cn) [OSChina](https://my.oschina.net/sunhaojava)

## License

The `Lodsve Framework` is released under version 3.0 of the [GNU General Public License](https://opensource.org/licenses/GPL-3.0).