spring boot api project seed

소개

Spring Boot API Project Seed는 Spring Boot와 MyBatis를 기반으로 하는 시드 프로젝트로, 중소형 API 및 RESTful API 프로젝트를 빠르게 구축하는 데 사용됩니다. 이 시드 프로젝트는 안정적이고 간단하며, 반복적인 작업의 경우 비즈니스 코드 작성에 집중하고 초과 근무를 줄이세요. 다음은 본 프로젝트를 기반으로 간단한 API를 단 몇십초만에 구현하고 실행하여 서비스를 제공하는 방법을 보여주는 간단한 사용법 데모입니다.

기능 및 제안

• 모범 사례 프로젝트 구조, 구성 파일, 간소화된 POM(프로젝트 구조 다이어그램 보기)
• 통합 응답 결과 패키징 및 생성 도구
• 통합 예외 처리
• 간단한 인터페이스 서명 인증
• 일반적으로 사용되는 기본 메소드의 추상 캡슐화
• Druid Spring Boot Starter를 사용하여 Druid 데이터베이스 연결 풀 및 모니터링 통합
• FastJsonHttpMessageConverter를 사용하여 JSON 직렬화 속도 향상
• MyBatis, 범용 Mapper 플러그인 및 PageHelper 페이징 플러그인을 통합하여 단일 테이블 비즈니스를 위한 제로 SQL 달성
• 테이블 이름을 기준으로 Model, Mapper, MapperXML, Service, ServiceImpl, Controller 등 해당 기본 코드를 생성할 수 있는 코드 생성기가 제공됩니다. Controller 템플릿은 기본적으로 POST 및 RESTful 두 세트를 제공하므로 필요에 따라 선택할 수 있습니다. CodeGenerator.genController(tableName) 메서드에서 POST 템플릿이 기본적으로 사용됩니다. 코드 템플릿은 회사마다 업무가 다르기 때문에, 실제 프로젝트에서 반복되는 코드 작성을 줄일 수 있는 아이디어를 제공하는 것이 주된 목적입니다 . I 사용 중에는 실제로 회사의 업무를 추상화한 것을 바탕으로 수많은 템플릿이 작성되어 있습니다. 또한 템플릿을 사용하면 팀의 코딩 스타일을 통일되게 유지하는 데 도움이 될 수도 있습니다.
• 탐험을 기다리는 부활절 달걀도 있습니다

빠른 시작

1. 프로젝트 복제
2. 테이블 이름을 기준으로 코드를 생성해야 하므로 주로 JDBC인 test 패키지에 코드 생성기 CodeGenerator 구성합니다.
3. 위의 데모를 기반으로 직접 시도해보고 싶다면 test resources 디렉터리에서 demo-user.sql 사용할 수 있습니다. 그렇지 않으면 이 단계를 무시하세요.
4. 테이블 이름을 입력하고 CodeGenerator.main() 메서드를 실행하여 기본 코드를 생성합니다. (나오려면 프로젝트 디렉터리를 새로 고쳐야 할 수도 있습니다.)
5. 업무에 따른 기본코드 확장
6. 개발 환경 구성 파일 application-dev.properties 를 구성하고 프로젝트를 시작하세요. Have Fun!

개발 제안

• 테이블 이름에는 소문자를 사용하는 것이 좋습니다. 여러 단어를 결합하려면 밑줄을 사용하세요.
• 모델의 멤버 변수는 테이블 필드 수에 해당하는 것이 좋습니다. 멤버 변수를 확장해야 하는 경우(예: 테이블 쿼리 연결) DTO를 생성하는 것이 좋습니다. 그렇지 않으면 @Transient 추가해야 합니다. 확장 멤버 변수에 대한 @Transient 주석. 자세한 내용은 일반 Mapper 플러그인 설명서를 참조하세요.
• ServiceException("message") 사용하여 서비스 실패를 직접 발생시키는 것이 좋습니다. 통합 예외 프로세서는 throw new ServiceException("该手机号已被注册") 와 같은 비즈니스 실패의 응답 결과를 캡슐화합니다. {"code":400,"message":"该手机号已被注册"} 반환으로 직접 캡슐화됩니다. 직접 처리할 필요 없이 원하는 만큼 던지기만 하면 됩니다.
• 도구 클래스가 필요한 경우 먼저 apache-commons-* 및 guava 에서 찾는 것이 좋습니다. 실제로 휠을 다시 만들거나 클래스 라이브러리를 도입할 필요가 없습니다.
• 개발 사양은 Alibaba Java 개발 매뉴얼(최신 버전 다운로드)을 따르는 것이 좋습니다.
• API 문서를 작성하고 관리하려면 회사 내 ShowDoc, SpringFox-Swagger2, RAP 및 기타 오픈 소스 프로젝트를 사용하는 것이 좋습니다.

기술 선택 및 문서화

• Spring Boot(Spring Boot 학습 및 사용 가이드 보기)
• MyBatis (공식 중국어 문서 보기)
• MyBatisb 범용 매퍼 플러그인(공식 중국어 문서 참조)
• MyBatis PageHelper 페이징 플러그인(공식 중국어 문서 참조)
• Druid Spring Boot Starter(공식 중국어 문서 참조)
• Fastjson(공식 중국어 문서 참조)
• 기타 약간

특허

없음, 순수한 오픈 소스 공유입니다. Star & Fork의 지원에 감사드립니다.