├── .mvn └── wrapper │ └── maven-wrapper.properties ├── src ├── main │ ├── java │ │ └── com │ │ │ └── example │ │ │ └── demo │ │ │ ├── query │ │ │ ├── RoleQuery.java │ │ │ └── UserQuery.java │ │ │ ├── dto │ │ │ ├── RoleDTO.java │ │ │ └── UserDTO.java │ │ │ ├── command │ │ │ ├── RoleModifyCommand.java │ │ │ ├── RoleCreateCommand.java │ │ │ ├── UserCreateCommand.java │ │ │ └── UserModifyCommand.java │ │ │ ├── repository │ │ │ ├── RoleRepository.java │ │ │ └── UserRepository.java │ │ │ ├── Application.java │ │ │ ├── domain │ │ │ ├── Address.java │ │ │ ├── Role.java │ │ │ └── User.java │ │ │ ├── aop │ │ │ ├── ResultExceptionHandler.java │ │ │ └── ResultExceptionAspect.java │ │ │ ├── service │ │ │ ├── RoleService.java │ │ │ ├── UserService.java │ │ │ └── impl │ │ │ │ ├── UserServiceImpl.java │ │ │ │ └── RoleServiceImpl.java │ │ │ ├── ex │ │ │ └── BusinessException.java │ │ │ ├── assembler │ │ │ ├── RoleAssembler.java │ │ │ └── UserAssembler.java │ │ │ └── controller │ │ │ ├── RoleController.java │ │ │ ├── UserController.java │ │ │ └── Result.java │ └── resources │ │ ├── application.properties │ │ └── scripts │ │ └── schema.sql └── test │ └── java │ └── com │ └── example │ └── demo │ └── DemoApplicationTests.java ├── .gitignore ├── .github └── workflows │ └── github-actions-ci.yml ├── README.md ├── pom.xml ├── mvnw.cmd ├── mvnw └── LICENSE /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip 2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar 3 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/query/RoleQuery.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.query; 2 | 3 | import lombok.Data; 4 | 5 | /** 6 | * . 7 | * 8 | * @author Jarvis Song 9 | */ 10 | @Data 11 | public class RoleQuery { 12 | 13 | private String name; 14 | 15 | } 16 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/dto/RoleDTO.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.dto; 2 | 3 | import lombok.Data; 4 | 5 | /** 6 | * . 7 | * 8 | * @author Jarvis Song 9 | */ 10 | @Data 11 | public class RoleDTO { 12 | 13 | private Long id; 14 | private String name; 15 | } 16 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/command/RoleModifyCommand.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.command; 2 | 3 | import lombok.Data; 4 | 5 | /** 6 | * . 7 | * 8 | * @author Jarvis Song 9 | */ 10 | @Data 11 | public class RoleModifyCommand { 12 | 13 | 14 | private String name; 15 | 16 | } 17 | -------------------------------------------------------------------------------- /src/test/java/com/example/demo/DemoApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.example.demo; 2 | 3 | import org.junit.jupiter.api.Test; 4 | import org.springframework.boot.test.context.SpringBootTest; 5 | 6 | @SpringBootTest 7 | class DemoApplicationTests { 8 | 9 | @Test 10 | void contextLoads() { 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/command/RoleCreateCommand.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.command; 2 | 3 | import com.example.demo.domain.Address; 4 | import lombok.Data; 5 | 6 | /** 7 | * . 8 | * 9 | * @author Jarvis Song 10 | */ 11 | @Data 12 | public class RoleCreateCommand { 13 | 14 | 15 | private String name; 16 | 17 | } 18 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/repository/RoleRepository.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.repository; 2 | 3 | import com.example.demo.domain.Role; 4 | import io.easybest.mybatis.repository.MybatisRepository; 5 | 6 | /** 7 | * . 8 | * 9 | * @author Jarvis Song 10 | */ 11 | public interface RoleRepository extends MybatisRepository { 12 | } 13 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/repository/UserRepository.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.repository; 2 | 3 | import com.example.demo.domain.User; 4 | import io.easybest.mybatis.repository.MybatisRepository; 5 | 6 | /** 7 | * . 8 | * 9 | * @author Jarvis Song 10 | */ 11 | public interface UserRepository extends MybatisRepository { 12 | } 13 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/query/UserQuery.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.query; 2 | 3 | import lombok.Data; 4 | 5 | /** 6 | * . 7 | * 8 | * @author Jarvis Song 9 | */ 10 | @Data 11 | public class UserQuery { 12 | 13 | private String emailAddress; 14 | 15 | private String firstname; 16 | 17 | private String lastname; 18 | 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/Application.java: -------------------------------------------------------------------------------- 1 | package com.example.demo; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class Application { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(Application.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/domain/Address.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.domain; 2 | 3 | import javax.persistence.Embeddable; 4 | 5 | import lombok.Data; 6 | 7 | /** 8 | * . 9 | * 10 | * @author Jarvis Song 11 | */ 12 | @Embeddable 13 | @Data 14 | public class Address { 15 | 16 | 17 | private String country; 18 | 19 | private String city; 20 | 21 | private String streetName; 22 | 23 | private String streetNo; 24 | 25 | } 26 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/aop/ResultExceptionHandler.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.aop; 2 | 3 | import java.lang.annotation.ElementType; 4 | import java.lang.annotation.Retention; 5 | import java.lang.annotation.RetentionPolicy; 6 | import java.lang.annotation.Target; 7 | 8 | /** 9 | * Identify controller mapping result will handle by aspect exception handler. 10 | * 11 | * @author Jarvis Song 12 | */ 13 | @Target(ElementType.METHOD) 14 | @Retention(RetentionPolicy.RUNTIME) 15 | public @interface ResultExceptionHandler { 16 | 17 | } 18 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/command/UserCreateCommand.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.command; 2 | 3 | import com.example.demo.domain.Address; 4 | import lombok.Data; 5 | 6 | /** 7 | * . 8 | * 9 | * @author Jarvis Song 10 | */ 11 | @Data 12 | public class UserCreateCommand { 13 | 14 | 15 | private String emailAddress; 16 | 17 | private String firstname; 18 | 19 | private String lastname; 20 | 21 | private int age; 22 | 23 | private boolean active; 24 | 25 | private Address address; 26 | 27 | private Long managerId; 28 | 29 | } 30 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/command/UserModifyCommand.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.command; 2 | 3 | import com.example.demo.domain.Address; 4 | import lombok.Data; 5 | 6 | /** 7 | * . 8 | * 9 | * @author Jarvis Song 10 | */ 11 | @Data 12 | public class UserModifyCommand { 13 | 14 | 15 | private String emailAddress; 16 | 17 | private String firstname; 18 | 19 | private String lastname; 20 | 21 | private int age; 22 | 23 | private boolean active; 24 | 25 | private Address address; 26 | 27 | private Long managerId; 28 | 29 | } 30 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | spring.application.name=demo 2 | spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver 3 | spring.datasource.url=jdbc:mysql://127.0.0.1:3306/demo?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowPublicKeyRetrieval=true 4 | spring.datasource.username=root 5 | spring.datasource.password=root 6 | spring.sql.init.mode=always 7 | spring.sql.init.schema-locations=classpath*:scripts/schema.sql 8 | 9 | spring.data.mybatis.repositories.naming-strategy-type=underscore 10 | spring.data.mybatis.repositories.uniform-table-prefix=DO_ -------------------------------------------------------------------------------- /src/main/java/com/example/demo/domain/Role.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.domain; 2 | 3 | import javax.persistence.Entity; 4 | import javax.persistence.Table; 5 | 6 | import io.easybest.mybatis.domain.LongId; 7 | import lombok.Data; 8 | import lombok.EqualsAndHashCode; 9 | import lombok.ToString; 10 | 11 | /** 12 | * . 13 | * 14 | * @author Jarvis Song 15 | */ 16 | @Entity 17 | @Table(name = "ROLE") 18 | @Data 19 | @EqualsAndHashCode(callSuper = true) 20 | @ToString(callSuper = true) 21 | public class Role extends LongId { 22 | 23 | private String name; 24 | 25 | } 26 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/dto/UserDTO.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.dto; 2 | 3 | import java.util.Set; 4 | 5 | import com.example.demo.domain.Address; 6 | import lombok.Data; 7 | 8 | /** 9 | * . 10 | * 11 | * @author Jarvis Song 12 | */ 13 | @Data 14 | public class UserDTO { 15 | 16 | private Long id; 17 | 18 | private String emailAddress; 19 | 20 | private String firstname; 21 | 22 | private String lastname; 23 | 24 | private int age; 25 | 26 | private boolean active; 27 | 28 | private Address address; 29 | 30 | private UserDTO manager; 31 | 32 | private Set roles; 33 | } 34 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *# 2 | *.iml 3 | *.ipr 4 | *.iws 5 | *.jar 6 | *.sw? 7 | *~ 8 | .#* 9 | .*.md.html 10 | .DS_Store 11 | .attach_pid* 12 | .classpath 13 | .factorypath 14 | .gradle 15 | .idea 16 | .metadata 17 | .project 18 | .recommenders 19 | .settings 20 | .springBeans 21 | .vscode 22 | /code 23 | MANIFEST.MF 24 | _site/ 25 | activemq-data 26 | bin 27 | build 28 | 29 | 30 | !/**/src/**/bin 31 | !/**/src/**/build 32 | !/gradle/wrapper/gradle-wrapper.jar 33 | build.log 34 | dependency-reduced-pom.xml 35 | dump.rdb 36 | interpolated*.xml 37 | lib/ 38 | manifest.yml 39 | out 40 | overridedb.* 41 | target 42 | transaction-logs 43 | .flattened-pom.xml 44 | secrets.yml 45 | .gradletasknamecache 46 | .sts4-cache 47 | /main/src/test/resources/check/ 48 | testcase.db 49 | 50 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/service/RoleService.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.service; 2 | 3 | import com.example.demo.command.RoleCreateCommand; 4 | import com.example.demo.command.RoleModifyCommand; 5 | import com.example.demo.dto.RoleDTO; 6 | import com.example.demo.query.RoleQuery; 7 | 8 | import org.springframework.data.domain.ExampleMatcher; 9 | import org.springframework.data.domain.Page; 10 | import org.springframework.data.domain.Pageable; 11 | 12 | /** 13 | * . 14 | * 15 | * @author Jarvis Song 16 | */ 17 | public interface RoleService { 18 | 19 | Page find(Pageable pageable, RoleQuery query, ExampleMatcher matcher); 20 | 21 | RoleDTO getById(Long id); 22 | 23 | Long create(RoleCreateCommand command); 24 | 25 | void modify(Long id, RoleModifyCommand command); 26 | 27 | void patch(Long id, RoleModifyCommand command); 28 | 29 | void remove(Long id); 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/service/UserService.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.service; 2 | 3 | import com.example.demo.command.UserCreateCommand; 4 | import com.example.demo.command.UserModifyCommand; 5 | import com.example.demo.dto.UserDTO; 6 | import com.example.demo.query.UserQuery; 7 | 8 | import org.springframework.data.domain.ExampleMatcher; 9 | import org.springframework.data.domain.Page; 10 | import org.springframework.data.domain.Pageable; 11 | 12 | /** 13 | * . 14 | * 15 | * @author Jarvis Song 16 | */ 17 | public interface UserService { 18 | 19 | Page find(Pageable pageable, UserQuery query, ExampleMatcher matcher); 20 | 21 | UserDTO getById(Long id); 22 | 23 | Long create(UserCreateCommand command); 24 | 25 | void modify(Long id, UserModifyCommand command); 26 | 27 | void patch(Long id, UserModifyCommand command); 28 | 29 | void remove(Long id); 30 | } 31 | -------------------------------------------------------------------------------- /.github/workflows/github-actions-ci.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | on: [ push ] 3 | jobs: 4 | build: 5 | runs-on: ubuntu-latest 6 | strategy: 7 | matrix: 8 | java: [ 11, 17 ] 9 | name: 'Build on Java ${{ matrix.java }}' 10 | services: 11 | mysql: 12 | image: mysql 13 | env: 14 | MYSQL_DATABASE: demo 15 | MYSQL_ROOT_PASSWORD: root 16 | ports: 17 | - 3306:3306 18 | steps: 19 | - uses: actions/checkout@v3 20 | - name: 'Set up JDK ${{ matrix.java }}' 21 | uses: actions/setup-java@v3 22 | with: 23 | java-version: '${{ matrix.java }}' 24 | distribution: 'adopt' 25 | - name: Cache Maven Dependencies 26 | uses: actions/cache@v3 27 | with: 28 | path: ~/.m2 29 | key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} 30 | restore-keys: ${{ runner.os }}-m2- 31 | - name: Build with Maven 32 | run: ./mvnw clean package -U 33 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/ex/BusinessException.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.ex; 2 | 3 | /** 4 | * Common business exception. 5 | * 6 | * @author Jarvis Song 7 | */ 8 | public class BusinessException extends RuntimeException { 9 | 10 | private final int code; 11 | 12 | public BusinessException(int code) { 13 | this.code = code; 14 | } 15 | 16 | public BusinessException(int code, String message) { 17 | super(message); 18 | this.code = code; 19 | } 20 | 21 | public BusinessException(int code, String message, Throwable cause) { 22 | super(message, cause); 23 | this.code = code; 24 | } 25 | 26 | public BusinessException(int code, Throwable cause) { 27 | super(cause); 28 | this.code = code; 29 | } 30 | 31 | public String getDefaultMessage() { 32 | return "A business exception occurred!"; 33 | } 34 | 35 | public int getCode() { 36 | return this.code; 37 | } 38 | 39 | } 40 | -------------------------------------------------------------------------------- /src/main/resources/scripts/schema.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE IF NOT EXISTS DO_USER 2 | ( 3 | ID BIGINT NOT NULL AUTO_INCREMENT, 4 | EMAIL_ADDRESS VARCHAR(128) NOT NULL, 5 | FIRSTNAME VARCHAR(32), 6 | LASTNAME VARCHAR(32), 7 | AGE INT(3), 8 | ACTIVE BOOLEAN, 9 | COUNTRY VARCHAR(255), 10 | CITY VARCHAR(255), 11 | STREET_NAME VARCHAR(255), 12 | STREET_NO VARCHAR(255), 13 | MANAGER_ID BIGINT, 14 | VERSION BIGINT DEFAULT 0 NOT NULL, 15 | DELETED INT(1) DEFAULT 0 NOT NULL, 16 | PRIMARY KEY (ID), 17 | UNIQUE KEY (EMAIL_ADDRESS) 18 | ); 19 | 20 | CREATE TABLE IF NOT EXISTS DO_ROLE 21 | ( 22 | ID BIGINT NOT NULL AUTO_INCREMENT, 23 | NAME VARCHAR(64) NOT NULL, 24 | PRIMARY KEY (ID), 25 | UNIQUE KEY (NAME) 26 | ); 27 | 28 | CREATE TABLE IF NOT EXISTS DO_USER_ROLE 29 | ( 30 | USER_ID BIGINT NOT NULL, 31 | ROLE_ID BIGINT NOT NULL, 32 | PRIMARY KEY (USER_ID, ROLE_ID) 33 | ); -------------------------------------------------------------------------------- /src/main/java/com/example/demo/assembler/RoleAssembler.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.assembler; 2 | 3 | import com.example.demo.command.RoleCreateCommand; 4 | import com.example.demo.command.RoleModifyCommand; 5 | import com.example.demo.domain.Role; 6 | import com.example.demo.dto.RoleDTO; 7 | import com.example.demo.query.RoleQuery; 8 | import org.mapstruct.Mapper; 9 | import org.mapstruct.Mapping; 10 | import org.mapstruct.Named; 11 | 12 | import static org.mapstruct.InjectionStrategy.CONSTRUCTOR; 13 | 14 | /** 15 | * . 16 | * 17 | * @author Jarvis Song 18 | */ 19 | @Mapper(componentModel = "spring", injectionStrategy = CONSTRUCTOR) 20 | public interface RoleAssembler { 21 | 22 | @Named("toDTO") 23 | RoleDTO toDTO(Role role); 24 | 25 | @Mapping(target = "id", ignore = true) 26 | @Named("fromQuery") 27 | Role fromQuery(RoleQuery query); 28 | 29 | 30 | @Mapping(target = "id", ignore = true) 31 | Role fromCreateCommand(RoleCreateCommand command); 32 | 33 | 34 | @Mapping(target = "id", ignore = true) 35 | Role fromModifyCommand(RoleModifyCommand command); 36 | 37 | } 38 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/aop/ResultExceptionAspect.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.aop; 2 | 3 | import com.example.demo.controller.Result; 4 | import com.example.demo.ex.BusinessException; 5 | import lombok.extern.slf4j.Slf4j; 6 | import org.aspectj.lang.ProceedingJoinPoint; 7 | import org.aspectj.lang.annotation.Around; 8 | import org.aspectj.lang.annotation.Aspect; 9 | 10 | 11 | /** 12 | * Aspect for exception throwing from controller method. 13 | * 14 | * @author Jarvis Song 15 | */ 16 | @Slf4j 17 | @Aspect 18 | public class ResultExceptionAspect { 19 | 20 | @Around("@annotation(com.example.demo.aop.ResultExceptionHandler)") 21 | public Object handleResultException(ProceedingJoinPoint joinPoint) throws Throwable { 22 | try { 23 | return joinPoint.proceed(); 24 | } catch (BusinessException ex) { 25 | return Result.fail(ex.getCode(), null != ex.getMessage() ? ex.getMessage() : ex.getDefaultMessage()); 26 | } catch (Exception ex) { 27 | log.error(ex.getMessage(), ex); 28 | return Result.fail(500, ex.getMessage()); 29 | } 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/domain/User.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.domain; 2 | 3 | import java.util.Set; 4 | 5 | import javax.persistence.Embedded; 6 | import javax.persistence.Entity; 7 | import javax.persistence.JoinTable; 8 | import javax.persistence.ManyToMany; 9 | import javax.persistence.ManyToOne; 10 | import javax.persistence.Table; 11 | import javax.persistence.Version; 12 | 13 | import io.easybest.mybatis.annotation.DatabaseDefault; 14 | import io.easybest.mybatis.domain.LongId; 15 | import lombok.Data; 16 | import lombok.EqualsAndHashCode; 17 | import lombok.ToString; 18 | 19 | /** 20 | * . 21 | * 22 | * @author Jarvis Song 23 | */ 24 | @Entity 25 | @Table(name = "USER") 26 | @Data 27 | @EqualsAndHashCode(callSuper = true) 28 | @ToString(callSuper = true) 29 | public class User extends LongId { 30 | 31 | private String emailAddress; 32 | 33 | private String firstname; 34 | 35 | private String lastname; 36 | 37 | private int age; 38 | 39 | private boolean active; 40 | 41 | @Embedded 42 | private Address address; 43 | 44 | @ManyToOne 45 | private User manager; 46 | 47 | @ManyToMany 48 | @JoinTable(name = "USER_ROLE") 49 | private Set roles; 50 | 51 | @Version 52 | @DatabaseDefault 53 | private Integer version; 54 | 55 | public User() { 56 | } 57 | 58 | public User(Long id) { 59 | 60 | super(id); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | 4 | 5 |

6 | 7 | ---- 8 | 9 |

10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 |

23 | 24 | 25 | This is a demo project based on [Spring Data MyBatis](https://github.com/easybest/spring-data-mybatis). 26 | According to this demo project, you can quickly learn the basic usage of Spring Data MyBatis. 27 | 28 | ## How to Start 29 | 30 | ```shell 31 | ./mvnw spring-boot:run 32 | ``` -------------------------------------------------------------------------------- /src/main/java/com/example/demo/assembler/UserAssembler.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.assembler; 2 | 3 | import com.example.demo.command.UserCreateCommand; 4 | import com.example.demo.command.UserModifyCommand; 5 | import com.example.demo.domain.User; 6 | import com.example.demo.dto.UserDTO; 7 | import com.example.demo.query.UserQuery; 8 | import org.mapstruct.Mapper; 9 | import org.mapstruct.Mapping; 10 | import org.mapstruct.Named; 11 | 12 | import static org.mapstruct.InjectionStrategy.CONSTRUCTOR; 13 | 14 | /** 15 | * . 16 | * 17 | * @author Jarvis Song 18 | */ 19 | @Mapper(componentModel = "spring", injectionStrategy = CONSTRUCTOR, uses = {RoleAssembler.class}) 20 | public interface UserAssembler { 21 | 22 | @Mapping(target = "version", ignore = true) 23 | @Mapping(target = "roles", ignore = true) 24 | @Mapping(target = "manager", ignore = true) 25 | @Mapping(target = "id", ignore = true) 26 | @Mapping(target = "age", ignore = true) 27 | @Mapping(target = "address", ignore = true) 28 | @Mapping(target = "active", ignore = true) 29 | @Named("fromQuery") 30 | User fromQuery(UserQuery query); 31 | 32 | @Named("toDTO") 33 | @Mapping(source = "manager", target = "manager", qualifiedByName = "toDTO") 34 | @Mapping(source = "roles", target = "roles", qualifiedByName = "toDTO") 35 | UserDTO toDTO(User user); 36 | 37 | @Mapping(target = "version", ignore = true) 38 | @Mapping(target = "roles", ignore = true) 39 | @Mapping(target = "manager", ignore = true) 40 | @Mapping(target = "id", ignore = true) 41 | User fromCreateCommand(UserCreateCommand command); 42 | 43 | @Mapping(target = "version", ignore = true) 44 | @Mapping(target = "roles", ignore = true) 45 | @Mapping(target = "manager", ignore = true) 46 | @Mapping(target = "id", ignore = true) 47 | User fromModifyCommand(UserModifyCommand command); 48 | } 49 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/controller/RoleController.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.controller; 2 | 3 | import com.example.demo.aop.ResultExceptionHandler; 4 | import com.example.demo.command.RoleCreateCommand; 5 | import com.example.demo.command.RoleModifyCommand; 6 | import com.example.demo.dto.RoleDTO; 7 | import com.example.demo.query.RoleQuery; 8 | import com.example.demo.service.RoleService; 9 | 10 | import org.springframework.data.domain.ExampleMatcher; 11 | import org.springframework.data.domain.Page; 12 | import org.springframework.data.domain.Pageable; 13 | import org.springframework.data.web.PageableDefault; 14 | import org.springframework.validation.annotation.Validated; 15 | import org.springframework.web.bind.annotation.DeleteMapping; 16 | import org.springframework.web.bind.annotation.GetMapping; 17 | import org.springframework.web.bind.annotation.PatchMapping; 18 | import org.springframework.web.bind.annotation.PathVariable; 19 | import org.springframework.web.bind.annotation.PostMapping; 20 | import org.springframework.web.bind.annotation.PutMapping; 21 | import org.springframework.web.bind.annotation.RequestBody; 22 | import org.springframework.web.bind.annotation.RequestMapping; 23 | import org.springframework.web.bind.annotation.RestController; 24 | 25 | /** 26 | * . 27 | * 28 | * @author Jarvis Song 29 | */ 30 | @RestController 31 | @RequestMapping("/api/role") 32 | public class RoleController { 33 | private final RoleService service; 34 | 35 | public RoleController(RoleService roleService) { 36 | this.service = roleService; 37 | } 38 | 39 | @GetMapping 40 | public Result> list(@PageableDefault(size = 20) Pageable pageable, @Validated RoleQuery query) { 41 | 42 | return Result.success(this.service.find(pageable, query, ExampleMatcher.matching())); 43 | } 44 | 45 | @GetMapping("{id}") 46 | @ResultExceptionHandler 47 | Result fetch(@PathVariable("id") Long id) { 48 | 49 | return Result.success(this.service.getById(id)); 50 | } 51 | 52 | @PostMapping 53 | Result create(@Validated @RequestBody RoleCreateCommand command) { 54 | 55 | return Result.success(this.service.create(command)); 56 | } 57 | 58 | @PutMapping("{id}") 59 | @ResultExceptionHandler 60 | Result modify(@PathVariable("id") Long id, @Validated @RequestBody RoleModifyCommand command) { 61 | 62 | this.service.modify(id, command); 63 | return Result.success(id); 64 | } 65 | 66 | @PatchMapping("{id}") 67 | @ResultExceptionHandler 68 | Result patch(@PathVariable("id") Long id, @Validated @RequestBody RoleModifyCommand command) { 69 | 70 | this.service.patch(id, command); 71 | 72 | return Result.success(id); 73 | } 74 | 75 | @DeleteMapping("{id}") 76 | @ResultExceptionHandler 77 | Result remove(@PathVariable Long id) { 78 | 79 | this.service.remove(id); 80 | 81 | return Result.TRUE; 82 | } 83 | } 84 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/controller/UserController.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.controller; 2 | 3 | import com.example.demo.aop.ResultExceptionHandler; 4 | import com.example.demo.command.UserCreateCommand; 5 | import com.example.demo.command.UserModifyCommand; 6 | import com.example.demo.dto.UserDTO; 7 | import com.example.demo.query.UserQuery; 8 | import com.example.demo.service.UserService; 9 | 10 | import org.springframework.data.domain.ExampleMatcher; 11 | import org.springframework.data.domain.Page; 12 | import org.springframework.data.domain.Pageable; 13 | import org.springframework.data.web.PageableDefault; 14 | import org.springframework.validation.annotation.Validated; 15 | import org.springframework.web.bind.annotation.DeleteMapping; 16 | import org.springframework.web.bind.annotation.GetMapping; 17 | import org.springframework.web.bind.annotation.PatchMapping; 18 | import org.springframework.web.bind.annotation.PathVariable; 19 | import org.springframework.web.bind.annotation.PostMapping; 20 | import org.springframework.web.bind.annotation.PutMapping; 21 | import org.springframework.web.bind.annotation.RequestBody; 22 | import org.springframework.web.bind.annotation.RequestMapping; 23 | import org.springframework.web.bind.annotation.RestController; 24 | 25 | /** 26 | * . 27 | * 28 | * @author Jarvis Song 29 | */ 30 | @RestController 31 | @RequestMapping("/api/user") 32 | public class UserController { 33 | private final UserService service; 34 | 35 | public UserController(UserService userService) { 36 | this.service = userService; 37 | } 38 | 39 | @GetMapping 40 | @ResultExceptionHandler 41 | Result> list(@PageableDefault(size = 20) Pageable pageable, @Validated UserQuery query) { 42 | 43 | return Result.success(this.service.find(pageable, query, ExampleMatcher.matching())); 44 | } 45 | 46 | @GetMapping("{id}") 47 | @ResultExceptionHandler 48 | Result fetch(@PathVariable("id") Long id) { 49 | 50 | return Result.success(this.service.getById(id)); 51 | } 52 | 53 | @PostMapping 54 | Result create(@Validated @RequestBody UserCreateCommand command) { 55 | 56 | return Result.success(this.service.create(command)); 57 | } 58 | 59 | @PutMapping("{id}") 60 | @ResultExceptionHandler 61 | Result modify(@PathVariable("id") Long id, @Validated @RequestBody UserModifyCommand command) { 62 | 63 | this.service.modify(id, command); 64 | return Result.success(id); 65 | } 66 | 67 | @PatchMapping("{id}") 68 | @ResultExceptionHandler 69 | Result patch(@PathVariable("id") Long id, @Validated @RequestBody UserModifyCommand command) { 70 | 71 | this.service.patch(id, command); 72 | 73 | return Result.success(id); 74 | } 75 | 76 | @DeleteMapping("{id}") 77 | @ResultExceptionHandler 78 | Result remove(@PathVariable Long id){ 79 | 80 | this.service.remove(id); 81 | 82 | return Result.TRUE; 83 | } 84 | 85 | } 86 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/service/impl/UserServiceImpl.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.service.impl; 2 | 3 | import com.example.demo.assembler.UserAssembler; 4 | import com.example.demo.command.UserCreateCommand; 5 | import com.example.demo.command.UserModifyCommand; 6 | import com.example.demo.domain.User; 7 | import com.example.demo.dto.UserDTO; 8 | import com.example.demo.query.UserQuery; 9 | import com.example.demo.repository.UserRepository; 10 | import com.example.demo.service.UserService; 11 | 12 | import org.springframework.data.domain.Example; 13 | import org.springframework.data.domain.ExampleMatcher; 14 | import org.springframework.data.domain.Page; 15 | import org.springframework.data.domain.Pageable; 16 | import org.springframework.stereotype.Service; 17 | import org.springframework.transaction.annotation.Transactional; 18 | import org.springframework.util.Assert; 19 | 20 | /** 21 | * . 22 | * 23 | * @author Jarvis Song 24 | */ 25 | @Service 26 | public class UserServiceImpl implements UserService { 27 | 28 | 29 | private final UserRepository repository; 30 | private final UserAssembler assembler; 31 | 32 | public UserServiceImpl(UserRepository repository, UserAssembler assembler) { 33 | this.repository = repository; 34 | this.assembler = assembler; 35 | } 36 | 37 | 38 | @Override 39 | @Transactional(readOnly = true) 40 | public Page find(Pageable pageable, UserQuery query, ExampleMatcher matcher) { 41 | 42 | Assert.notNull(query, "query must not be null."); 43 | 44 | User probe = this.assembler.fromQuery(query); 45 | Example example = Example.of(probe, matcher); 46 | 47 | Page page = this.repository.findAll(example, pageable); 48 | return page.map(this.assembler::toDTO); 49 | } 50 | 51 | @Override 52 | @Transactional(readOnly = true) 53 | public UserDTO getById(Long id) { 54 | 55 | Assert.notNull(id, "id must not be null."); 56 | 57 | User user = this.repository.getById(id); 58 | if (null == user) { 59 | return null; 60 | } 61 | 62 | return this.assembler.toDTO(user); 63 | } 64 | 65 | @Override 66 | @Transactional 67 | public Long create(UserCreateCommand command) { 68 | 69 | User user = this.assembler.fromCreateCommand(command); 70 | User inserted = this.repository.insert(user); 71 | return inserted.getId(); 72 | } 73 | 74 | @Override 75 | @Transactional 76 | public void modify(Long id, UserModifyCommand command) { 77 | 78 | User user = this.assembler.fromModifyCommand(command); 79 | this.repository.update(id, user); 80 | } 81 | 82 | @Override 83 | @Transactional 84 | public void patch(Long id, UserModifyCommand command) { 85 | 86 | User user = this.assembler.fromModifyCommand(command); 87 | this.repository.updateSelective(id, user); 88 | } 89 | 90 | @Override 91 | @Transactional 92 | public void remove(Long id) { 93 | 94 | this.repository.deleteById(id); 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/service/impl/RoleServiceImpl.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.service.impl; 2 | 3 | import com.example.demo.assembler.RoleAssembler; 4 | import com.example.demo.command.RoleCreateCommand; 5 | import com.example.demo.command.RoleModifyCommand; 6 | import com.example.demo.domain.Role; 7 | import com.example.demo.dto.RoleDTO; 8 | import com.example.demo.query.RoleQuery; 9 | import com.example.demo.repository.RoleRepository; 10 | import com.example.demo.service.RoleService; 11 | 12 | import org.springframework.data.domain.Example; 13 | import org.springframework.data.domain.ExampleMatcher; 14 | import org.springframework.data.domain.Page; 15 | import org.springframework.data.domain.Pageable; 16 | import org.springframework.stereotype.Service; 17 | import org.springframework.transaction.annotation.Transactional; 18 | import org.springframework.util.Assert; 19 | 20 | /** 21 | * . 22 | * 23 | * @author Jarvis Song 24 | */ 25 | @Service 26 | public class RoleServiceImpl implements RoleService { 27 | 28 | private final RoleRepository repository; 29 | private final RoleAssembler assembler; 30 | 31 | 32 | public RoleServiceImpl(RoleRepository repository, RoleAssembler assembler) { 33 | this.repository = repository; 34 | this.assembler = assembler; 35 | } 36 | 37 | @Override 38 | @Transactional(readOnly = true) 39 | public Page find(Pageable pageable, RoleQuery query, ExampleMatcher matcher) { 40 | 41 | 42 | Assert.notNull(query, "query must not be null."); 43 | 44 | Role probe = this.assembler.fromQuery(query); 45 | Example example = Example.of(probe, matcher); 46 | 47 | Page page = this.repository.findAll(example, pageable); 48 | return page.map(this.assembler::toDTO); 49 | } 50 | 51 | 52 | @Override 53 | @Transactional(readOnly = true) 54 | public RoleDTO getById(Long id) { 55 | 56 | Assert.notNull(id, "id must not be null."); 57 | 58 | Role role = this.repository.getById(id); 59 | if (null == role) { 60 | return null; 61 | } 62 | 63 | return this.assembler.toDTO(role); 64 | } 65 | 66 | @Override 67 | @Transactional 68 | public Long create(RoleCreateCommand command) { 69 | 70 | Role role = this.assembler.fromCreateCommand(command); 71 | Role inserted = this.repository.insert(role); 72 | return inserted.getId(); 73 | } 74 | 75 | @Override 76 | @Transactional 77 | public void modify(Long id, RoleModifyCommand command) { 78 | 79 | Role role = this.assembler.fromModifyCommand(command); 80 | this.repository.update(id, role); 81 | } 82 | 83 | @Override 84 | @Transactional 85 | public void patch(Long id, RoleModifyCommand command) { 86 | 87 | Role role = this.assembler.fromModifyCommand(command); 88 | this.repository.updateSelective(id, role); 89 | } 90 | 91 | @Override 92 | @Transactional 93 | public void remove(Long id) { 94 | 95 | this.repository.deleteById(id); 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/controller/Result.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.controller; 2 | 3 | import java.io.Serializable; 4 | import java.util.LinkedHashMap; 5 | import java.util.Map; 6 | 7 | import com.fasterxml.jackson.annotation.JsonInclude; 8 | 9 | /** 10 | * Rest controller result wrapper. 11 | * 12 | * @param fill data type 13 | * @author Jarvis Song 14 | */ 15 | @JsonInclude(JsonInclude.Include.NON_NULL) 16 | public class Result extends LinkedHashMap implements Serializable { 17 | 18 | private static final long serialVersionUID = 8632514164317028380L; 19 | 20 | /** 21 | * Static result for true. 22 | */ 23 | public static final Result TRUE = success(true); 24 | 25 | private static final String KEY_SUCCESS = "success"; 26 | 27 | private static final String KEY_CODE = "code"; 28 | 29 | private static final String KEY_MESSAGE = "msg"; 30 | 31 | private static final String KEY_DATA = "data"; 32 | 33 | private static final String KEY_STATUS = "status"; 34 | 35 | private static final String KEY_FIELDS = "fields"; 36 | 37 | private static final int CODE_SUCCESS = 200; 38 | 39 | private static final int CODE_ERROR = 500; 40 | 41 | public Result(boolean success, int code, T data) { 42 | this.setSuccess(success).setCode(code).setData(data); 43 | } 44 | 45 | public static Result success(T data) { 46 | return success(CODE_SUCCESS, data); 47 | } 48 | 49 | public static Result success(int code, T data) { 50 | return new Result<>(true, code, data); 51 | } 52 | 53 | public static Result fail(int code, String message) { 54 | return new Result(false, code, null).setMsg(message); 55 | 56 | } 57 | 58 | public static Result fail(int code, String message, T data) { 59 | return new Result<>(false, code, data).setMsg(message); 60 | 61 | } 62 | 63 | public static Result fail(String message) { 64 | return fail(CODE_ERROR, message); 65 | } 66 | 67 | public boolean isSuccess() { 68 | return (boolean) this.get(KEY_SUCCESS); 69 | } 70 | 71 | public Result setSuccess(boolean success) { 72 | return this.set(KEY_SUCCESS, success); 73 | } 74 | 75 | public int getCode() { 76 | return (int) this.get(KEY_CODE); 77 | } 78 | 79 | public Result setCode(int code) { 80 | this.set(KEY_STATUS, code >= 200 && code < 300 ? 0 : code); 81 | return this.set(KEY_CODE, code); 82 | } 83 | 84 | public String getMsg() { 85 | return (String) this.get(KEY_MESSAGE); 86 | } 87 | 88 | public Result setMsg(String message) { 89 | return this.set(KEY_MESSAGE, message); 90 | } 91 | 92 | public int getStatus() { 93 | return (int) this.get(KEY_STATUS); 94 | 95 | } 96 | 97 | public Result setFields(Map fields) { 98 | return this.set(KEY_FIELDS, fields); 99 | } 100 | 101 | @SuppressWarnings({"unchecked"}) 102 | public Map getFields() { 103 | return (Map) this.get(KEY_FIELDS); 104 | } 105 | 106 | @SuppressWarnings({"unchecked"}) 107 | public T getData() { 108 | return (T) this.get(KEY_DATA); 109 | } 110 | 111 | public Result setData(T data) { 112 | return this.set(KEY_DATA, data); 113 | } 114 | 115 | public Result set(String key, Object value) { 116 | this.put(key, value); 117 | return this; 118 | } 119 | 120 | public Result setMap(Map map) { 121 | this.putAll(map); 122 | return this; 123 | } 124 | 125 | @Override 126 | public String toString() { 127 | return "{\"success\": " + this.isSuccess() + ",\"code\": " + this.getCode() + ",\"status\": " + this.getStatus() 128 | + ",\"message\": \"" + this.getMsg() + "\",\"data\": " + this.getData() + "}"; 129 | } 130 | 131 | } 132 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 2.7.2 9 | 10 | 11 | com.example 12 | demo 13 | 0.0.1-SNAPSHOT 14 | demo 15 | Demo project for Spring Data MyBatis 16 | 17 | 11 18 | 1.5.2.Final 19 | 20 | 21 | 22 | 23 | 24 | io.easybest 25 | spring-data-mybatis-boot-starter 26 | 2.1.0-SNAPSHOT 27 | 28 | 29 | 30 | org.springframework.boot 31 | spring-boot-starter-web 32 | 33 | 34 | org.springframework.boot 35 | spring-boot-starter-actuator 36 | 37 | 38 | org.aspectj 39 | aspectjweaver 40 | 41 | 42 | mysql 43 | mysql-connector-java 44 | runtime 45 | 46 | 47 | 48 | org.springframework.boot 49 | spring-boot-starter-test 50 | test 51 | 52 | 53 | org.mapstruct 54 | mapstruct 55 | ${org.mapstruct.version} 56 | 57 | 58 | org.projectlombok 59 | lombok 60 | true 61 | 62 | 63 | 64 | 65 | 66 | 67 | org.springframework.boot 68 | spring-boot-maven-plugin 69 | 70 | 71 | 72 | org.projectlombok 73 | lombok 74 | 75 | 76 | 77 | 78 | 79 | org.apache.maven.plugins 80 | maven-compiler-plugin 81 | 3.8.1 82 | 83 | ${java.version} 84 | ${java.version} 85 | 86 | 87 | org.projectlombok 88 | lombok 89 | ${lombok.version} 90 | 91 | 92 | org.mapstruct 93 | mapstruct-processor 94 | ${org.mapstruct.version} 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | oss-snapshots-repo 104 | https://oss.sonatype.org/content/repositories/snapshots 105 | 106 | false 107 | 108 | 109 | true 110 | 111 | 112 | 113 | 114 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 50 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 124 | 125 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 127 | ) 128 | 129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 131 | if exist %WRAPPER_JAR% ( 132 | if "%MVNW_VERBOSE%" == "true" ( 133 | echo Found %WRAPPER_JAR% 134 | ) 135 | ) else ( 136 | if not "%MVNW_REPOURL%" == "" ( 137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 138 | ) 139 | if "%MVNW_VERBOSE%" == "true" ( 140 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 141 | echo Downloading from: %DOWNLOAD_URL% 142 | ) 143 | 144 | powershell -Command "&{"^ 145 | "$webclient = new-object System.Net.WebClient;"^ 146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 148 | "}"^ 149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ 150 | "}" 151 | if "%MVNW_VERBOSE%" == "true" ( 152 | echo Finished downloading %WRAPPER_JAR% 153 | ) 154 | ) 155 | @REM End of extension 156 | 157 | @REM Provide a "standardized" way to retrieve the CLI args that will 158 | @REM work with both Windows and non-Windows executions. 159 | set MAVEN_CMD_LINE_ARGS=%* 160 | 161 | %MAVEN_JAVA_EXE% ^ 162 | %JVM_CONFIG_MAVEN_PROPS% ^ 163 | %MAVEN_OPTS% ^ 164 | %MAVEN_DEBUG_OPTS% ^ 165 | -classpath %WRAPPER_JAR% ^ 166 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 167 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 168 | if ERRORLEVEL 1 goto error 169 | goto end 170 | 171 | :error 172 | set ERROR_CODE=1 173 | 174 | :end 175 | @endlocal & set ERROR_CODE=%ERROR_CODE% 176 | 177 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 178 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 179 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 180 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 181 | :skipRcPost 182 | 183 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 184 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 185 | 186 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 187 | 188 | cmd /C exit /B %ERROR_CODE% 189 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /usr/local/etc/mavenrc ] ; then 40 | . /usr/local/etc/mavenrc 41 | fi 42 | 43 | if [ -f /etc/mavenrc ] ; then 44 | . /etc/mavenrc 45 | fi 46 | 47 | if [ -f "$HOME/.mavenrc" ] ; then 48 | . "$HOME/.mavenrc" 49 | fi 50 | 51 | fi 52 | 53 | # OS specific support. $var _must_ be set to either true or false. 54 | cygwin=false; 55 | darwin=false; 56 | mingw=false 57 | case "`uname`" in 58 | CYGWIN*) cygwin=true ;; 59 | MINGW*) mingw=true;; 60 | Darwin*) darwin=true 61 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 62 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 63 | if [ -z "$JAVA_HOME" ]; then 64 | if [ -x "/usr/libexec/java_home" ]; then 65 | export JAVA_HOME="`/usr/libexec/java_home`" 66 | else 67 | export JAVA_HOME="/Library/Java/Home" 68 | fi 69 | fi 70 | ;; 71 | esac 72 | 73 | if [ -z "$JAVA_HOME" ] ; then 74 | if [ -r /etc/gentoo-release ] ; then 75 | JAVA_HOME=`java-config --jre-home` 76 | fi 77 | fi 78 | 79 | if [ -z "$M2_HOME" ] ; then 80 | ## resolve links - $0 may be a link to maven's home 81 | PRG="$0" 82 | 83 | # need this for relative symlinks 84 | while [ -h "$PRG" ] ; do 85 | ls=`ls -ld "$PRG"` 86 | link=`expr "$ls" : '.*-> \(.*\)$'` 87 | if expr "$link" : '/.*' > /dev/null; then 88 | PRG="$link" 89 | else 90 | PRG="`dirname "$PRG"`/$link" 91 | fi 92 | done 93 | 94 | saveddir=`pwd` 95 | 96 | M2_HOME=`dirname "$PRG"`/.. 97 | 98 | # make it fully qualified 99 | M2_HOME=`cd "$M2_HOME" && pwd` 100 | 101 | cd "$saveddir" 102 | # echo Using m2 at $M2_HOME 103 | fi 104 | 105 | # For Cygwin, ensure paths are in UNIX format before anything is touched 106 | if $cygwin ; then 107 | [ -n "$M2_HOME" ] && 108 | M2_HOME=`cygpath --unix "$M2_HOME"` 109 | [ -n "$JAVA_HOME" ] && 110 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 111 | [ -n "$CLASSPATH" ] && 112 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 113 | fi 114 | 115 | # For Mingw, ensure paths are in UNIX format before anything is touched 116 | if $mingw ; then 117 | [ -n "$M2_HOME" ] && 118 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 119 | [ -n "$JAVA_HOME" ] && 120 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 121 | fi 122 | 123 | if [ -z "$JAVA_HOME" ]; then 124 | javaExecutable="`which javac`" 125 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 126 | # readlink(1) is not available as standard on Solaris 10. 127 | readLink=`which readlink` 128 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 129 | if $darwin ; then 130 | javaHome="`dirname \"$javaExecutable\"`" 131 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 132 | else 133 | javaExecutable="`readlink -f \"$javaExecutable\"`" 134 | fi 135 | javaHome="`dirname \"$javaExecutable\"`" 136 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 137 | JAVA_HOME="$javaHome" 138 | export JAVA_HOME 139 | fi 140 | fi 141 | fi 142 | 143 | if [ -z "$JAVACMD" ] ; then 144 | if [ -n "$JAVA_HOME" ] ; then 145 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 146 | # IBM's JDK on AIX uses strange locations for the executables 147 | JAVACMD="$JAVA_HOME/jre/sh/java" 148 | else 149 | JAVACMD="$JAVA_HOME/bin/java" 150 | fi 151 | else 152 | JAVACMD="`\\unset -f command; \\command -v java`" 153 | fi 154 | fi 155 | 156 | if [ ! -x "$JAVACMD" ] ; then 157 | echo "Error: JAVA_HOME is not defined correctly." >&2 158 | echo " We cannot execute $JAVACMD" >&2 159 | exit 1 160 | fi 161 | 162 | if [ -z "$JAVA_HOME" ] ; then 163 | echo "Warning: JAVA_HOME environment variable is not set." 164 | fi 165 | 166 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 167 | 168 | # traverses directory structure from process work directory to filesystem root 169 | # first directory with .mvn subdirectory is considered project base directory 170 | find_maven_basedir() { 171 | 172 | if [ -z "$1" ] 173 | then 174 | echo "Path not specified to find_maven_basedir" 175 | return 1 176 | fi 177 | 178 | basedir="$1" 179 | wdir="$1" 180 | while [ "$wdir" != '/' ] ; do 181 | if [ -d "$wdir"/.mvn ] ; then 182 | basedir=$wdir 183 | break 184 | fi 185 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 186 | if [ -d "${wdir}" ]; then 187 | wdir=`cd "$wdir/.."; pwd` 188 | fi 189 | # end of workaround 190 | done 191 | echo "${basedir}" 192 | } 193 | 194 | # concatenates all lines of a file 195 | concat_lines() { 196 | if [ -f "$1" ]; then 197 | echo "$(tr -s '\n' ' ' < "$1")" 198 | fi 199 | } 200 | 201 | BASE_DIR=`find_maven_basedir "$(pwd)"` 202 | if [ -z "$BASE_DIR" ]; then 203 | exit 1; 204 | fi 205 | 206 | ########################################################################################## 207 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 208 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 209 | ########################################################################################## 210 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 211 | if [ "$MVNW_VERBOSE" = true ]; then 212 | echo "Found .mvn/wrapper/maven-wrapper.jar" 213 | fi 214 | else 215 | if [ "$MVNW_VERBOSE" = true ]; then 216 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 217 | fi 218 | if [ -n "$MVNW_REPOURL" ]; then 219 | jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 220 | else 221 | jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 222 | fi 223 | while IFS="=" read key value; do 224 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 225 | esac 226 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 227 | if [ "$MVNW_VERBOSE" = true ]; then 228 | echo "Downloading from: $jarUrl" 229 | fi 230 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 231 | if $cygwin; then 232 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` 233 | fi 234 | 235 | if command -v wget > /dev/null; then 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Found wget ... using wget" 238 | fi 239 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 240 | wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 241 | else 242 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 243 | fi 244 | elif command -v curl > /dev/null; then 245 | if [ "$MVNW_VERBOSE" = true ]; then 246 | echo "Found curl ... using curl" 247 | fi 248 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 249 | curl -o "$wrapperJarPath" "$jarUrl" -f 250 | else 251 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f 252 | fi 253 | 254 | else 255 | if [ "$MVNW_VERBOSE" = true ]; then 256 | echo "Falling back to using Java to download" 257 | fi 258 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 259 | # For Cygwin, switch paths to Windows format before running javac 260 | if $cygwin; then 261 | javaClass=`cygpath --path --windows "$javaClass"` 262 | fi 263 | if [ -e "$javaClass" ]; then 264 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 265 | if [ "$MVNW_VERBOSE" = true ]; then 266 | echo " - Compiling MavenWrapperDownloader.java ..." 267 | fi 268 | # Compiling the Java class 269 | ("$JAVA_HOME/bin/javac" "$javaClass") 270 | fi 271 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 272 | # Running the downloader 273 | if [ "$MVNW_VERBOSE" = true ]; then 274 | echo " - Running MavenWrapperDownloader.java ..." 275 | fi 276 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 277 | fi 278 | fi 279 | fi 280 | fi 281 | ########################################################################################## 282 | # End of extension 283 | ########################################################################################## 284 | 285 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 286 | if [ "$MVNW_VERBOSE" = true ]; then 287 | echo $MAVEN_PROJECTBASEDIR 288 | fi 289 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 290 | 291 | # For Cygwin, switch paths to Windows format before running java 292 | if $cygwin; then 293 | [ -n "$M2_HOME" ] && 294 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 295 | [ -n "$JAVA_HOME" ] && 296 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 297 | [ -n "$CLASSPATH" ] && 298 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 299 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 300 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 301 | fi 302 | 303 | # Provide a "standardized" way to retrieve the CLI args that will 304 | # work with both Windows and non-Windows executions. 305 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" 306 | export MAVEN_CMD_LINE_ARGS 307 | 308 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 309 | 310 | exec "$JAVACMD" \ 311 | $MAVEN_OPTS \ 312 | $MAVEN_DEBUG_OPTS \ 313 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 314 | "-Dmaven.home=${M2_HOME}" \ 315 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 316 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 317 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | https://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | https://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------