Skip to content

Latest commit

 

History

History
149 lines (116 loc) · 5.24 KB

README.md

File metadata and controls

149 lines (116 loc) · 5.24 KB
Raw

Mandatory Parameter

Mandatory Parameter is required parameters for communication between backend service.

Setup Dependency

<dependency>
  <groupId>com.blibli.oss</groupId>
  <artifactId>blibli-backend-framework-mandatory-parameter</artifactId>
</dependency>

Get Mandatory Parameter

Mandatory parameter represent with MandatoryParameter class. We also provide MandatoryParameterHandlerMethodArgumentResolver to automatically inject MandatoryParameter in controller.

@RestController
public class CustomerController {

  @PostMapping(
    value = "/api/customers",
    produces = MediaType.APPLICATION_JSON_VALUE,
    consumes = MediaType.APPLICATION_JSON_VALUE
  )
  public Mono<Response<CreateCustomerWebResponse>> create(MandatoryParameter mandatoryParameter,
                                                          @RequestBody CreateCustomerWebRequest request) {
    return commandExecutor.execute(CreateCustomerCommand.class, toCreateCustomerCommandRequest(mandatoryParameter, request))
      .map(ResponseHelper::ok)
      .subscribeOn(commandScheduler);
  }
}

Mandatory Parameter Properties

Mandatory parameter will be resolved from query param or http header. If we want, we can change the query param key or header key to resolve it.

blibli.backend.mandatoryparameter.header-key.channel-id=channelId
blibli.backend.mandatoryparameter.header-key.client-id=clientId
blibli.backend.mandatoryparameter.header-key.request-id=requestId
blibli.backend.mandatoryparameter.header-key.store-id=storeId
blibli.backend.mandatoryparameter.header-key.username=username

blibli.backend.mandatoryparameter.query-key.channel-id=channelId
blibli.backend.mandatoryparameter.query-key.client-id=clientId
blibli.backend.mandatoryparameter.query-key.request-id=requestId
blibli.backend.mandatoryparameter.query-key.store-id=storeId
blibli.backend.mandatoryparameter.query-key.username=username

Swagger Support

If we already include Swagger Module, we can also automatically register Mandatory Parameter to swagger api doc using annotation :

  • @MandatoryParameterAtHeader if using http header
  • @MandatoryParameterAtQuery if using query param
@RestController
public class CustomerController {

  @MandatoryParameterAtHeader
  @PostMapping(
    value = "/api/customers",
    produces = MediaType.APPLICATION_JSON_VALUE,
    consumes = MediaType.APPLICATION_JSON_VALUE
  )
  public Mono<Response<CreateCustomerWebResponse>> create(MandatoryParameter mandatoryParameter,
                                                          @RequestBody CreateCustomerWebRequest request) {
    return commandExecutor.execute(CreateCustomerCommand.class, toCreateCustomerCommandRequest(request))
      .map(ResponseHelper::ok)
      .subscribeOn(commandScheduler);
  }
}

We can also change default value for mandatory parameter on swagger using properties

blibli.backend.mandatoryparameter.header-key.channel-id-default-value=channelId
blibli.backend.mandatoryparameter.header-key.client-id-default-value=clientId
blibli.backend.mandatoryparameter.header-key.request-id-default-value=requestId
blibli.backend.mandatoryparameter.header-key.store-id-default-value=storeId
blibli.backend.mandatoryparameter.header-key.username-default-value=username

blibli.backend.mandatoryparameter.query-key.channel-id-default-value=channelId
blibli.backend.mandatoryparameter.query-key.client-id-default-value=clientId
blibli.backend.mandatoryparameter.query-key.request-id-default-value=requestId
blibli.backend.mandatoryparameter.query-key.store-id-default-value=storeId
blibli.backend.mandatoryparameter.query-key.username-default-value=username

Sleuth Integration

Sometimes we want to get mandatory parameter not only in Controller, maybe on Service or other class. Thanks to spring sleuth, we can set and get baggage from anywhere using Tracer. Mandatory Parameter module already support integration with spring sleuth. So we can get mandatory parameter from span.

@Service
public static class SleuthService {

  @Autowired
  private Tracer tracer;

  public Mono<MandatoryParameter> getMandatoryParameter() {
    return Mono.fromCallable(() -> MandatoryParameterHelper.fromSleuth(tracer.currentSpan().context()));
  }

}

API Client Integration

Sometimes our service need to hit other backend service using API Client. And Other backend service also required mandatory parameter. To simplify this, we don't need to do it manually passing mandatory parameter using query param or header. This module also support forward mandatory parameter to api client using interceptor MandatoryParameterApiClientInterceptor.

We can use interceptor in @ApiClient annotation

@ApiClient(
  name = "secondApiClient",
  interceptors = {
    MandatoryParameterApiClientInterceptor.class
  }
)
public interface SecondApiClient {

  @RequestMapping(
    value = "/second",
    method = RequestMethod.GET,
    produces = MediaType.APPLICATION_JSON_VALUE
  )
  Mono<Map<String, String>> second();

}

or using properties

blibli.backend.apiclient.configs.firstApiClient.url=http://first-service-host:8080
blibli.backend.apiclient.configs.firstApiClient.interceptors[0]=com.blibli.oss.backend.mandatoryparameter.apiclient.MandatoryParameterApiClientInterceptor