bliblidotcom / blibli-backend-framework

Blibli.com Backend Framework

Blibli Backend Framework

Blibli Backend Framework is various spring boot 2 libraries for Blibli.com backend projects.

Setup

To use blibli backend framework, we need to setup our pom.xml

<!-- Set parent project -->
<parent>
    <groupId>com.blibli.oss</groupId>
    <artifactId>blibli-backend-framework</artifactId>
    <version>...</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<!-- Set blibli framework version -->
<properties>
    <blibli-framework.version>...</blibli-framework.version>
</properties>

<!-- add blibli bintray repository --> 
<repositories>
    <repository>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
      <id>bintray-bliblidotcom-maven</id>
      <name>bintray</name>
      <url>https://dl.bintray.com/bliblidotcom/maven</url>
    </repository>
</repositories>

Example Project

If you need example project, you can see this repository :

https://github.com/bliblidotcom/blibli-backend-framework-example

List of Libraries

• Common : standard request and response
• Mandatory Parameter : mandatory parameter for backend to backend communication
• Version : standard application version information
• Swagger : open api and swagger generator
• Reactor : simplify project reactor usage
• API Client : non blocking declarative restful api client
• Kafka : simplify spring kafka usage
• Command : command pattern implementation
• Aggregate Query : api client for aggregate query
• Scheduler Platform : api client for scheduler platform
• JSON: simplify json manipulation usage
• Validation : reactive bean validation
• Sleuth : simplify spring sleuth usage
• External API : helper for external api app
• Internal API : helper for internal api app

blibli-backend-framework's Issues

as a developer, I want to use spring boot 2.2.6

Static request params not supported in ApiClient.

ApiClient does not support static request params via properties,
ex.
blibli.backend.apiclient.configs.sleuthApiClient.params.storeId=storeId

as a developer, I want to create kafka consumer interceptor just for specific kafka listener

ApiClient does not read spring default CodecProperties

What
I set spring.codec.max-in-memory-size=100MB

Expected
ApiClient data buffer will increase

Actual
ApiClient data buffer still set to default 256K

How to fix
In ApiClientMethodInterceptor, make it read the CodecProperties too, see org.springframework.boot.autoconfigure.http.codec.CodecsAutoConfiguration.DefaultCodecsConfiguration.defaultCodecCustomizer

Workaround
Create ApiClientCodecCustomizer and set defaultCodec's maxInMemorySize

ApiClient doesn't encode URI with proper URI EncodingMethod

For example I have apiClientX with following path:
/get?query[id][is]=xyz and abc

xyz and abc is URI values, passed through api client method interface.

And I set DefaultUriBuilderFactory.EncodingMode=VALUES_ONLY.

Then send the request...

Expectation
/get?query[id][is]=xyz+and+abc
(url template is NOT encoded, url values is encoded)

Actual
/get?query[id][is]=xyz and abc
(url template is NOT encoded, url values is NOT encoded)

Current workaround
Encode the xyz and abc manually with java URI encoder method before passing it to apiClientX.

Will fill up later for sample code.

as a developer, I want to send mandatory parameter to sleuth manually

as a developer, I want to use spring cloud version Hoxton.SR3

ApiClient breaks when using spring-boot-devtools

When spring-boot-devtools is included in classpath, project startup fail because in ApiClientMethodInterceptor.prepareFallback() method, the XClientFallback bean is not found/has not been initiated yet.

@RequestParam with no name / value is not supported

If you use the following:
@RequestParam String requestParamOne, it will not work because the name of the param is taken by the name or value of the annotation
String name = StringUtils.isEmpty(annotation.name()) ? annotation.value() : annotation.name();
Hence, the need for declaring it as follows:
@RequestParam("requestParamOne") String requestParamOne
But ideally, it should be taken as the default if empty, from the Parameter's name field ( parameter.getName() )

as a developer, I want include reactor extra dependency on reactor module

As a developer, I want get exception detail on fallback method

Sometimes I want to get the exception detail on fallback method
So I can return different fallback response for different exception