Доступ к защищенному API OAuth из Spring Batch

Question

У моей компании есть защищенный API OAuth 2, к которому мне нужен доступ из процесса Spring Batch или Scheduled. Я могу получить доступ к этому API из наших веб-приложений, используя следующий код:

Сначала я создал компонент WebClient

@Configuration
public class ScimOAuthConfiguration 
{

    /**
     * This class creates and returns a WebClient 
     * that has been built to authenticate with 
     * SCIM using OAuth2
     * 
     * @param clientRegistrationRepository
     * @param authorizedClientRepository
     * @return WebClient
     */

    @Bean
    WebClient scimWebClient(ClientRegistrationRepository clientRegistrationRepository, 
            OAuth2AuthorizedClientRepository authorizedClientRepository) 
    {
        //Creates a Servlet OAuth2 Authorized Client Exchange Filter
        ServletOAuth2AuthorizedClientExchangeFilterFunction oauth = 
                new ServletOAuth2AuthorizedClientExchangeFilterFunction(
                        clientRegistrationRepository, authorizedClientRepository);

        //Returns WebClient with OAuth2 filter applied to it
        return WebClient.builder().apply(oauth.oauth2Configuration()).build();
    }
}

Приведенный ниже метод userSearch () просто выполняет запрос к конечной точке, и преобразует результаты в некоторые классы, которые я создал.

@Component
@Slf4j
public class UserSearchService {

    private final UserUtil userUtil;

    private final WebClient webClient;

    public UserSearchService(UserUtil userUtil, WebClient webClient) {
        this.userUtil = userUtil;
        this.webClient = webClient;
    }

    /**
     * This method will query the SCIM API and return the results.
     */
    public Schema<User> userSearch(UserSearchForm form) {

        if (form.getCwsId().isEmpty() && form.getLastName().isEmpty() && form.getFirstName().isEmpty() && form.getEmail().isEmpty()) {
            return null;
        }

        //generate the request URI
        String uri = userUtil.generateSearchURL(form);

        //Creates a User Schema object to contain the results of the web request
        Schema<User> users = null;

        try {
            users = this.webClient.get()
                    .uri(uri)
                    .attributes(ServletOAuth2AuthorizedClientExchangeFilterFunction.clientRegistrationId("scim"))
                    .retrieve()
                    .bodyToMono(new ParameterizedTypeReference<Schema<User>>() {
                    })
                    .block();

        } catch (WebClientResponseException ex) {
            log.error(ex.getMessage(), ex);
        }

        return users;

    }
}

Когда я вызываю эту функцию в контроллере или конечной точке покоя, все работает просто отлично. Пример:

@RestController
@Slf4j
public class UserSearchController {

    @Autowired
    UserSearchService service;

    @PostMapping(value="/userSearch")
    public Schema<User> userSearch(@RequestBody UserSearchForm form) {
        return service.userSearch(form);
    }

}

Пока проблем нет ...

Мне дали задание, которое требует от меня создания задания Spring Batch, которое будет запускаться каждую ночь в полночь. Часть этой пакетной работы потребует от меня сбора информации о пользователях через защищенный API. Я бы предпочел поместить эту пакетную работу в свой проект веб-приложения. Цель состоит в том, чтобы это веб-приложение работало на сервере, и каждую ночь в полночь запускайте это пакетное задание, которое просто отправляет автоматические напоминания по электронной почте. Было бы неплохо, чтобы все было автономно и в одном хранилище. Вот мой упрощенный пример пакетного задания, которое пытается получить доступ к защищенному API:

@Configuration
@Slf4j
public class ReminderEmailJob {

    @Autowired
    JobBuilderFactory jobBuilderFactory;

    @Autowired
    StepBuilderFactory stepBuilderFactory;

    @Autowired
    UserSearchService userSearchService;

    @Bean
    public Job job() {
        return this.jobBuilderFactory.get("basicJob")
                .start(step1())
                .build();
    }

    @Bean
    public Step step1() {
        return this.stepBuilderFactory.get("step1").tasklet((contribution, chunkContext) -> {
            UserSearchForm form = new UserSearchForm("", "", "userNameHere", "");
            Schema<User> user = userSearchService.userSearch(form);
            System.out.println(user);

            log.info("Hello, world!");
            return RepeatStatus.FINISHED;
        }).build();
    }
}

Вот метод @Scheduled, который будет запускать это пакетное задание каждую ночь в полночь:

@Service
@Configuration
@EnableScheduling
@Slf4j
public class EmailScheduler {

    @Autowired
    ReminderEmailJob job;

    @Autowired
    JobLauncher jobLauncher;

    @Scheduled(cron = "0 0 0 * * *")
    public void runAutomatedEmailBatchJob() throws JobParametersInvalidException, JobExecutionAlreadyRunningException, JobRestartException, JobInstanceAlreadyCompleteException {
        jobLauncher.run(job.job(), new JobParametersBuilder().addDate("launchDate", new Date()).toJobParameters());
    }
}

Когда я пытаюсь запустить пакетное задание, я получаю следующую ошибку:

2020-02-19 10:21:38,347 ERROR [scheduling-1] org.springframework.batch.core.step.AbstractStep: Encountered an error executing step step1 in job basicJob
java.lang.IllegalArgumentException: request cannot be null
    at org.springframework.util.Assert.notNull(Assert.java:198)
    at org.springframework.security.oauth2.client.web.HttpSessionOAuth2AuthorizedClientRepository.loadAuthorizedClient(HttpSessionOAuth2AuthorizedClientRepository.java:47)
    at org.springframework.security.oauth2.client.web.AuthenticatedPrincipalOAuth2AuthorizedClientRepository.loadAuthorizedClient(AuthenticatedPrincipalOAuth2AuthorizedClientRepository.java:75)
    at org.springframework.security.oauth2.client.web.reactive.function.client.ServletOAuth2AuthorizedClientExchangeFilterFunction.populateDefaultOAuth2AuthorizedClient(ServletOAuth2AuthorizedClientExchangeFilterFunction.java:321)
    at org.springframework.security.oauth2.client.web.reactive.function.client.ServletOAuth2AuthorizedClientExchangeFilterFunction.lambda$null$1(ServletOAuth2AuthorizedClientExchangeFilterFunction.java:187)
    at org.springframework.web.reactive.function.client.DefaultWebClient$DefaultRequestBodyUriSpec.attributes(DefaultWebClient.java:234)
    at org.springframework.web.reactive.function.client.DefaultWebClient$DefaultRequestBodyUriSpec.attributes(DefaultWebClient.java:153)
    at org.springframework.security.oauth2.client.web.reactive.function.client.ServletOAuth2AuthorizedClientExchangeFilterFunction.lambda$defaultRequest$2(ServletOAuth2AuthorizedClientExchangeFilterFunction.java:184)
    at org.springframework.web.reactive.function.client.DefaultWebClient$DefaultRequestBodyUriSpec.initRequestBuilder(DefaultWebClient.java:324)
    at org.springframework.web.reactive.function.client.DefaultWebClient$DefaultRequestBodyUriSpec.exchange(DefaultWebClient.java:318)
    at org.springframework.web.reactive.function.client.DefaultWebClient$DefaultRequestBodyUriSpec.retrieve(DefaultWebClient.java:368)
    at com.cat.reman.springbootvuejs.dao.service.cgds.UserSearchService.userSearch(UserSearchService.java:53)
    at com.cat.reman.springbootvuejs.batch.ReminderEmailJob.lambda$step1$0(ReminderEmailJob.java:47)
    at org.springframework.batch.core.step.tasklet.TaskletStep$ChunkTransactionCallback.doInTransaction(TaskletStep.java:407)
    at org.springframework.batch.core.step.tasklet.TaskletStep$ChunkTransactionCallback.doInTransaction(TaskletStep.java:331)
    at org.springframework.transaction.support.TransactionTemplate.execute(TransactionTemplate.java:140)
    at org.springframework.batch.core.step.tasklet.TaskletStep$2.doInChunkContext(TaskletStep.java:273)
    at org.springframework.batch.core.scope.context.StepContextRepeatCallback.doInIteration(StepContextRepeatCallback.java:82)
    at org.springframework.batch.repeat.support.RepeatTemplate.getNextResult(RepeatTemplate.java:375)
    at org.springframework.batch.repeat.support.RepeatTemplate.executeInternal(RepeatTemplate.java:215)
    at org.springframework.batch.repeat.support.RepeatTemplate.iterate(RepeatTemplate.java:145)
    at org.springframework.batch.core.step.tasklet.TaskletStep.doExecute(TaskletStep.java:258)
    at org.springframework.batch.core.step.AbstractStep.execute(AbstractStep.java:203)
    at org.springframework.batch.core.job.SimpleStepHandler.handleStep(SimpleStepHandler.java:148)
    at org.springframework.batch.core.job.AbstractJob.handleStep(AbstractJob.java:399)
    at org.springframework.batch.core.job.SimpleJob.doExecute(SimpleJob.java:135)
    at org.springframework.batch.core.job.AbstractJob.execute(AbstractJob.java:313)
    at org.springframework.batch.core.launch.support.SimpleJobLauncher$1.run(SimpleJobLauncher.java:144)
    at org.springframework.core.task.SyncTaskExecutor.execute(SyncTaskExecutor.java:50)
    at org.springframework.batch.core.launch.support.SimpleJobLauncher.run(SimpleJobLauncher.java:137)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.base/java.lang.reflect.Method.invoke(Method.java:564)
    at org.springframework.aop.support.AopUtils.invokeJoinpointUsingReflection(AopUtils.java:343)
    at org.springframework.aop.framework.ReflectiveMethodInvocation.invokeJoinpoint(ReflectiveMethodInvocation.java:198)
    at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:163)
    at org.springframework.batch.core.configuration.annotation.SimpleBatchConfiguration$PassthruAdvice.invoke(SimpleBatchConfiguration.java:127)
    at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186)
    at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:212)
    at com.sun.proxy.$Proxy131.run(Unknown Source)
    at com.cat.reman.springbootvuejs.dao.service.emailService.EmailScheduler.jakeTest(EmailScheduler.java:162)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.base/java.lang.reflect.Method.invoke(Method.java:564)
    at org.springframework.scheduling.support.ScheduledMethodRunnable.run(ScheduledMethodRunnable.java:84)
    at org.springframework.scheduling.support.DelegatingErrorHandlingRunnable.run(DelegatingErrorHandlingRunnable.java:54)
    at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:514)
    at java.base/java.util.concurrent.FutureTask.runAndReset(FutureTask.java:305)
    at java.base/java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:300)
    at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1167)
    at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:641)
    at java.base/java.lang.Thread.run(Thread.java:844)

, что приводит меня к мысли, что в контексте веб-приложения мы можем получить доступ к компоненту WebClient, который был создан просто отлично. Когда дело доходит до пакетной работы, это другая история. Я обнаружил, что эти два экземпляра будут работать в разных потоках и не будут использовать одну и ту же информацию или контекст.

Мой вопрос: как мне получить доступ к защищенному API аналогичным образом с помощью Spring Batch? У меня есть идентификатор клиента токена OAuth, секрет клиента и т. Д. c. доступный. Спасибо.

Answer 1

Мой вопрос: как мне получить доступ к защищенному API аналогичным образом с помощью Spring Batch? У меня есть идентификатор клиента токена OAuth, секрет клиента и т. Д. c. доступно

Вы можете создать пользовательский ItemReader на основе OAuth2RestTemplate для доступа к защищенному API. Я нашел этот пример полезным. Просто убедитесь, что данные прочитаны в разбивке по страницам, чтобы не загружать все элементы в память одновременно.

При этом я не вижу необходимости запускать это задание в веб-приложении. Запуск вашего EmailScheduler в качестве автономного весеннего загрузочного приложения достаточно для IMO.