JarCastingspring-commons
Overview
This project contains the general-purpose tools to spring. Project is licensed under Apache License 2.0.
Roadmap
Consult the proyect for details on the current spring-commons roadmap.
Get it!
Install
Maven
Functionality of this package is contained in Java package com.github.damianwajser, and can be used using following Maven dependency:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.0.RELEASE</version>
</parent>
<properties>
...
<!-- Use the latest version whenever possible. -->
<spring.commons>{lastversion}</spring.commons>
...
</properties>
<dependencies>
...
<dependency>
<groupId>com.github.damianwajser</groupId>
<artifactId>spring-commons</artifactId>
<version>${spring.commons}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
...
</dependencies>
Gradle
compile 'com.github.damianwajser:spring-commons:{lastVersion}'
Usage Create a spring-boot application.
@SpringBootApplication
@EnableAutoConfiguration
@ComponentScan(basePackages = {"com.github.damianwajser","{YOUR-PACKAGE}"})
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
General configuration:
| Key | Value | Module | Reference |
|---|---|---|---|
| spring.jackson.property-naming-strategy | PropertyNamingStrategy.SnakeCaseStrategy | Spring web | format JSON response when Object is return in a controller |
| spring.commons.app.name | ${spring.commons.app.name} | All spring-commons | the name of microservice |
Modules
1 spring-commons-exception
Collection of exceptions for the most common cases when rest apis are built, and override the http code.
In addition, they request additional information for errors.
They can be used on their own, or they are caught by spring-commons-exception-handler and this information is used to generate a nice error message.
For example:
| Exception | Http Code |
|---|---|
| BadRequestException | 400 |
| PaymentRequiredException | 402 |
| ForbiddenException | 403 |
| PermissionDeniedException | 403 |
| NotFoundException | 404 |
2 spring-commons-rest-validation
This project override all annotations for standard JSR annotations.
Some annotations accept additional attributes like isNulleable, but the message and the bussisnessCode attributes are common to all of them.
Message: This is the message that will usually be rendered when the value of the respective property fails validation.
3 spring-commons-exception-handler
This module is responsible for generating error messages (REST) when an exception occurs, generating a unique interface for these occurrences. It is also in charge of correctly setting the HTTP codes in the message.
On the other hand, the internationalization option is enabled, for which in all the exceptions found in spring-commons-exceptions or the validations found in spring-commons-rest-validation We can enter placeholders when we talk about errors.
The language is selected by the client based on the header Accept-Lenguage: $ {locale} and this module will take it from the corresponding message.properties.
4 spring-commons-http-fixer
This project is in charge of solving the most common problems related to http codes in spring-mvc REST responses. Among other things, set the default http 201 code in the response when we are using the POST verb.
5 spring-commons-rest-templates
This project registers the RestTemplates to be used by the application.
At the same time, it incorporates an Interceptor to add custom headers (those that start with "X-"), to generate traceability between the microservices.
6 spring-commons-logger
This module generates useful tools for logging.
Among its features we find:
- StatsFilter (generates a log with the duration for each request)
- MDCFilter (it incorporates parameters in the MDC to be used in the loggin.pattern)
- RequestIdGenerator (a UUID is generated for each request in order to have traceability)
7 spring-commons-logger-logstash
This module configures the connector to logstash async way.
8 spring-commons-cache
This module tries to solve the typical problems that we encounter when we use Redis as Cache in spring. Configure:
- CacheManager
- RedisTemplate
It also improves the lifetime of the keys when we use @Cacheable.
9 spring-commons-idempotency
This module tries to solve the problems associated with idempotence. For them, create a filter within the spring chain of responsibilities. When the first request is made, it saves in redis the request sent by the client associated with an idempotence key. When another request is made two things can happen:
- The first request finished executing, which returns the same response that was obtained in the first call.
- In case the first request is still running, a message will be returned indicating the conflict.
10 spring-commons-actuator
<plugin>
<groupId>pl.project13.maven</groupId>
<artifactId>git-commit-id-plugin</artifactId>
<version>4.0.0</version>
<executions>
<execution>
<id>get-the-git-info</id>
<goals>
<goal>revision</goal>
</goals>
<phase>initialize</phase>
</execution>
</executions>
<configuration>
<generateGitPropertiesFile>true</generateGitPropertiesFile>
<generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
<commitIdGenerationMode>full</commitIdGenerationMode>
<offline>true</offline>
</configuration>
</plugin>
11 spring-commons-payment-utilities
Commons Issues:
DynamoDb
DynamoDb generate some issues connfiguring JPA:
@SpringBootApplication
@EnableDynamoDBRepositories(
includeFilters = {
@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = {
{YOUR-REPO1}.class, {YOUR-REPO1}.class})
}
)
@ComponentScan(basePackages = {"com.github.damianwajser","{YOUR-PACKAGE}"})
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
License
The Spring Framework is released under version 2.0 of the Apache License.