spring boot api project seed

Introduction

Spring Boot API Project Seed is a seed project based on Spring Boot & MyBatis. It is used to quickly build small and medium-sized API and RESTful API projects. This seed project has been practiced in many real projects. It is stable, simple and fast, allowing us to get rid of For those repetitive tasks, focus on writing business code and reduce overtime. The following is a simple usage demonstration to see how to implement a simple API in just a few dozen seconds based on this project and run it to provide services.

Features & Offers

• Best practice project structure, configuration files, streamlined POM (view project structure diagram)
• Unified response result packaging and generation tools
• Unified exception handling
• Simple interface signature authentication
• Abstract encapsulation of commonly used basic methods
• Use Druid Spring Boot Starter to integrate Druid database connection pool and monitoring
• Use FastJsonHttpMessageConverter to improve JSON serialization speed
• Integrate MyBatis, universal Mapper plug-in, and PageHelper paging plug-in to achieve zero SQL for single-table business
• A code generator is provided to generate corresponding basic codes such as Model, Mapper, MapperXML, Service, ServiceImpl, and Controller based on the table name. The Controller template provides two sets of POST and RESTful by default. You can choose according to your needs in the CodeGenerator.genController(tableName) method. The POST template is used by default. Code templates can be expanded according to the needs of actual projects. Since each company's business is different, we only provide some relatively basic and common templates. The main purpose is to provide an idea to reduce the writing of repeated code. In actual projects, I In use, a large number of templates are actually written based on the abstraction of the company's business. In addition, using templates can also help keep the team's coding style unified.
• There are also Easter eggs waiting for you to explore

quick start

1. Clone project
2. Configure the code generator CodeGenerator in the test package, mainly JDBC, because the code needs to be generated based on the table name
3. If you just want to try it yourself based on the above demonstration, you can use demo-user.sql in the test resources directory, otherwise ignore this step
4. Enter the table name, run CodeGenerator.main() method to generate basic code (you may need to refresh the project directory to come out)
5. Expand the basic code according to the business
6. Configure the development environment configuration file application-dev.properties , start the project, Have Fun!

Development suggestions

• For table names, it is recommended to use lowercase letters. Use underscores to join multiple words together.
• It is recommended that the member variables in the Model correspond to the number of table fields. If you need to extend the member variables (such as connecting table queries), it is recommended to create a DTO. Otherwise, you need to add @Transient annotation to the extended member variables. For details, see the general Mapper plug-in documentation.
• It is recommended that service failure be thrown directly using ServiceException("message") , and the unified exception processor will encapsulate the response result of business failure, such as throw new ServiceException("该手机号已被注册") , which will be directly encapsulated as {"code":400,"message":"该手机号已被注册"} returns, no need to handle it yourself, just throw it as much as you like
• If you need tool classes, it is recommended to find them from apache-commons-* and guava first. There is really no need to reinvent the wheel or introduce class libraries. Try to streamline the project.
• Development specifications are recommended to follow Alibaba Java Development Manual (download the latest version)
• It is recommended to use ShowDoc, SpringFox-Swagger2, RAP and other open source projects within the company to write and manage API documents

Technology Selection & Documentation

• Spring Boot (View Spring Boot Learning & Usage Guide)
• MyBatis (view official Chinese documentation)
• MyBatisb universal Mapper plug-in (see official Chinese documentation)
• MyBatis PageHelper paging plug-in (see official Chinese documentation)
• Druid Spring Boot Starter (see official Chinese documentation)
• Fastjson (see official Chinese documentation)
• Others slightly

License

None, purely open source sharing, thank you all Star & Fork for your support.