Tutorial da API da interface COM: Java Spring Boot + Biblioteca JACOB

Neste artigo, mostrarei como incorporar a biblioteca JACOB em seu aplicativo Spring Boot. Isso o ajudará a chamar uma API de interface COM por meio da biblioteca DLL em seu aplicativo da web.

Além disso, para fins ilustrativos, irei fornecer uma descrição de uma API COM para que você possa construir seu aplicativo sobre ela. Você pode encontrar todos os snippets de código neste repositório GitHub.

Mas, antes de mais nada, uma nota rápida: na C the Signs implantamos essa solução que nos permitiu a integração com o EMIS Health. É um sistema de registro eletrônico de pacientes usado na atenção primária no Reino Unido. Para integração, usamos a biblioteca DLL fornecida.

A abordagem que vou mostrar aqui (higienizada para evitar o vazamento de informações confidenciais) foi implementada em produção há mais de dois anos e, desde então, comprovou sua durabilidade.

Como recentemente empregamos uma abordagem totalmente nova para integração com o EMIS, o sistema antigo será encerrado em um ou dois meses. Portanto, este tutorial é o canto do cisne. Durma, meu pequeno príncipe.

O que é a API DLL?

Primeiro, vamos começar com uma descrição clara da biblioteca DLL. Para fazer isso, preparei um pequeno mock-up da documentação técnica original.

Vamos dar uma olhada nele para ver quais são os três métodos de uma interface COM.

Método InitialiseWithID

Este método é um recurso de segurança exigido no local que nos permite obter uma conexão com um servidor API que desejamos integrar à biblioteca.

Ele requer o AccountID(GUID) do usuário API atual (para acessar o servidor) e alguns outros argumentos de inicialização listados abaixo.

Esta função também oferece suporte a um recurso de login automático. Se um cliente tiver uma versão conectada do sistema em execução (a biblioteca faz parte desse sistema) e chamar o método no mesmo host, a API completará automaticamente o login na conta desse usuário. Em seguida, ele retornará o SessionIDpara chamadas de API subsequentes.

Caso contrário, o cliente precisa continuar com a Logonfunção (veja a próxima parte) usando o retornado LoginID.

Para chamar a função, use o nome InitialiseWithIDcom os seguintes argumentos:

Nome Dentro / fora Tipo Descrição
endereço Dentro Corda IP do servidor de integração fornecido
ID da conta Dentro Corda fornecido string GUID exclusivo
Identificação de usuário Fora Corda String GUID usada para chamada de API de logon
Erro Fora Corda Descrição de erro
Resultado Fora Inteiro -1 = Consulte o erro

1 = inicialização bem-sucedida aguardando logon

2 = Incapaz de conectar ao servidor devido à ausência do servidor ou detalhes incorretos

3 = AccountID sem correspondência

4 = Autologon bem sucedido

Identificação de sessão Fora Corda GUID usado para interações subsequentes (se o login automático for bem-sucedido)

Método de Logon

Este método determina a autoridade do usuário. O nome de usuário aqui é o ID usado para fazer login no sistema. A senha é a senha da API definida para esse nome de usuário.

No cenário de sucesso, a chamada retorna uma SessionIDstring (GUID) que deve ser passada para outras chamadas subsequentes para autenticá-las.

Para chamar a função, use o nome Logoncom os seguintes argumentos:

Nome Dentro / fora Tipo Descrição
Identificação de usuário Dentro Corda A id de login retornada pelo método de inicialização Initialise with ID
nome do usuário Dentro Corda nome de usuário API fornecido
senha Dentro Corda senha API fornecida
Identificação de sessão Fora Corda GUID usado para interações subsequentes (se o logon for bem-sucedido)
Erro Fora Corda Descrição de erro
Resultado Fora Inteiro -1 = Erro técnico

1 = Sucesso

2 = Expirado

3 = Sem sucesso

4 = ID de login inválido ou ID de login não tem acesso a este produto

Método getMatchedUsers

Esta chamada permite que você encontre registros de dados do usuário que correspondem a critérios específicos. O termo de pesquisa só pode se referir a um campo de cada vez, como sobrenome, nome ou data de nascimento.

Uma chamada bem-sucedida retorna uma string XML com os dados nela.

Para chamar a função, use o nome getMatchedUserscom os seguintes argumentos:

Nome Dentro / fora Tipo Descrição
Identificação de sessão Dentro Corda O id de sessão retornado pelo método de logon
MatchTerm Dentro Corda Termo de pesquisa
MatchedList Fora Corda XML em conformidade com o esquema XSD correspondente fornecido
Identificação de sessão Fora Corda GUID usado para interações subsequentes (se o logon for bem-sucedido)
Erro Fora Corda Descrição de erro
Resultado Fora Inteiro -1 = Erro técnico

1 = Usuários encontrados

2 = Acesso negado

3 = Sem usuários

Fluxo de aplicativo da biblioteca DLL

Para facilitar a compreensão do que queremos implementar, decidi criar um fluxograma simples.

Ele descreve um cenário passo a passo de como um cliente da web pode interagir com nosso aplicativo baseado em servidor usando sua API. Ele encapsula a interação com a Biblioteca DLL e nos permite obter usuários hipotéticos com o termo de correspondência fornecido (critérios de pesquisa):

Registrando COM

Agora vamos aprender como podemos acessar a biblioteca DLL. Para poder interagir com uma interface COM de terceiros, ela precisa ser adicionada ao registro.

Aqui está o que os documentos dizem:

O registro é um banco de dados do sistema que contém informações sobre a configuração do hardware e software do sistema, bem como sobre os usuários do sistema. Qualquer programa baseado no Windows pode adicionar informações ao registro e ler as informações do registro. Os clientes pesquisam o registro em busca de componentes interessantes para usar.

O registro mantém informações sobre todos os objetos COM instalados no sistema. Sempre que um aplicativo cria uma instância de um componente COM, o registro é consultado para resolver o CLSID ou o ProgID do componente no nome do caminho da DLL ou EXE do servidor que o contém.

Depois de determinar o servidor do componente, o Windows carrega o servidor no espaço de processo do aplicativo cliente (componentes em processo) ou inicia o servidor em seu próprio espaço de processo (servidores locais e remotos).

O servidor cria uma instância do componente e retorna ao cliente uma referência a uma das interfaces do componente.

Para saber como fazer isso, a documentação oficial da Microsoft diz:

Você pode executar uma ferramenta de linha de comando chamada Assembly Registration Tool (Regasm.exe) para registrar ou cancelar o registro de um assembly para uso com COM.

Regasm.exe adiciona informações sobre a classe ao registro do sistema para que os clientes COM possam usar a classe .NET Framework de forma transparente.

A classe RegistrationServices fornece a funcionalidade equivalente. Um componente gerenciado deve ser registrado no registro do Windows antes que possa ser ativado a partir de um cliente COM

Certifique-se de que sua máquina host instalou os .NET Frameworkcomponentes necessários . Depois disso, você pode executar o seguinte comando CLI:

C:\Windows\Microsoft.NET\Framework\v2.0.50727\RegAsm.exe {PATH_TO_YOUR_DLL_FILE} /codebase

A message will display indicating whether the file was successfully registered. Now we're ready for the next step.

Defining the Backbone of the Application

DllApiService

First of all, let's define the interface that describes our DLL library as it is:

public interface DllApiService { /** * @param accountId identifier for which we trigger initialisation * @return Tuple3 from values of Outcome, SessionID/LoginID, error * where by the first argument you can understand what is the result of the API call */ Mono
    
      initialiseWithID(String accountId); /** * @param loginId is retrieved before using {@link DllApiService#initialiseWithID(String)} call * @param username * @param password * @return Tuple3 from values of Outcome, SessionID, Error * where by the first argument you can understand what is the result of the API call */ Mono
     
       logon(String loginId, String username, String password); /** * @param sessionId is retrieved before using either * {@link DllApiService#initialiseWithID(String)} or * {@link DllApiService#logon(String, String, String)} calls * @param matchTerm * @return Tuple3 from values of Outcome, MatchedList, Error * where by the first argument you can understand what is the result of the API call */ Mono
      
        getMatchedUsers(String sessionId, String matchTerm); enum COM_API_Method { InitialiseWithID, Logon, getMatchedUsers } }
      
     
    

As you might have noticed, all the methods map with the definition of the COM Interface described above, except for the initialiseWithID function.

I decided to omit the address variable in the signature (the IP of the integration server) and inject it as an environment variable which we will be implementing.

SessionIDService Explained

To be able to retrieve any data using the library, first we need to get the SessionID.

According to the flow diagram above, this involves calling the initialiseWithID method first. After that, depending on the result, we will get either the SessionID or LoginID to use in subsequent Logon calls.

So basically this is a two-step process behind the scenes. Now, let's create the interface, and after that, the implementation:

public interface SessionIDService { /** * @param accountId identifier for which we retrieve SessionID * @param username * @param password * @return Tuple3 containing the following values: * result ( Boolean), sessionId (String) and status (HTTP Status depending on the result) */ Mono
    
      getSessionId(String accountId, String username, String password); }
    
@Service @RequiredArgsConstructor public class SessionIDServiceImpl implements SessionIDService { private final DllApiService dll; @Override public Mono
    
      getSessionId(String accountId, String username, String password) { return dll.initialiseWithID(accountId) .flatMap(t4 -> { switch (t4.getT1()) { case -1: return just(of(false, t4.getT3(), SERVICE_UNAVAILABLE)); case 1: { return dll.logon(t4.getT2(), username, password) .map(t3 -> { switch (t3.getT1()) { case -1: return of(false, t3.getT3(), SERVICE_UNAVAILABLE); case 1: return of(true, t3.getT2(), OK); case 2: case 4: return of(false, t3.getT3(), FORBIDDEN); default: return of(false, t3.getT3(), BAD_REQUEST); } }); } case 4: return just(of(true, t4.getT2(), OK)); default: return just(of(false, t4.getT3(), BAD_REQUEST)); } }); } }
    

API Facade

The next step is to design our web application API. It should represent and encapsulate our interaction with the COM Interface API:

@Configuration public class DllApiRouter { @Bean public RouterFunction dllApiRoute(DllApiRouterHandler handler) { return RouterFunctions.route(GET("/api/sessions/{accountId}"), handler::sessionId) .andRoute(GET("/api/users/{matchTerm}"), handler::matchedUsers); } }

Besides the Router class, let's define an implementation of its handler with logic for retrieving the SessionID and the user records data.

For the second scenario, to be able to make a DLL getMatchedUsers API call according to the design, let's use the mandatory header X-SESSION-ID:

@Slf4j @Component @RequiredArgsConstructor public class DllApiRouterHandler { private static final String SESSION_ID_HDR = "X-SESSION-ID"; private final DllApiService service; private final AccountRepo accountRepo; private final SessionIDService sessionService; public Mono sessionId(ServerRequest request) { final String accountId = request.pathVariable("accountId"); return accountRepo.findById(accountId) .flatMap(acc -> sessionService.getSessionId(accountId, acc.getApiUsername(), acc.getApiPassword())) .doOnEach(logNext(t3 -> { if (t3.getT1()) { log.info(format("SessionId to return %s", t3.getT2())); } else { log.warn(format("Session Id could not be retrieved. Cause: %s", t3.getT2())); } })) .flatMap(t3 -> status(t3.getT3()).contentType(APPLICATION_JSON) .bodyValue(t3.getT1() ? t3.getT2() : Response.error(t3.getT2()))) .switchIfEmpty(Mono.just("Account could not be found with provided ID " + accountId) .doOnEach(logNext(log::info)) .flatMap(msg -> badRequest().bodyValue(Response.error(msg)))); } public Mono matchedUsers(ServerRequest request) { return sessionIdHeader(request).map(sId -> Tuples.of(sId, request.queryParam("matchTerm") .orElseThrow(() -> new IllegalArgumentException( "matchTerm query param should be specified")))) .flatMap(t2 -> service.getMatchedUsers(t2.getT1(), t2.getT2())) .flatMap(this::handleT3) .onErrorResume(IllegalArgumentException.class, this::handleIllegalArgumentException); } private Mono sessionIdHeader(ServerRequest request) { return Mono.justOrEmpty(request.headers() .header(SESSION_ID_HDR) .stream() .findFirst() .orElseThrow(() -> new IllegalArgumentException(SESSION_ID_HDR + " header is mandatory"))); } private Mono handleT3(Tuple3 t3) { switch (t3.getT1()) { case 1: return ok().contentType(APPLICATION_JSON) .bodyValue(t3.getT2()); case 2: return status(FORBIDDEN).contentType(APPLICATION_JSON) .bodyValue(Response.error(t3.getT3())); default: return badRequest().contentType(APPLICATION_JSON) .bodyValue(Response.error(t3.getT3())); } } private Mono handleIllegalArgumentException(IllegalArgumentException e) { return Mono.just(Response.error(e.getMessage())) .doOnEach(logNext(res -> log.info(String.join(",", res.getErrors())))) .flatMap(res -> badRequest().contentType(MediaType.APPLICATION_JSON) .bodyValue(res)); } @Getter @Setter @NoArgsConstructor public static class Response implements Serializable { private String message; private Set errors; private Response(Set errors) { this.errors = errors; } public static Response error(String error) { return new Response(singleton(error)); } } }

Account Entity

As you might have noticed, we've imported AccountRepo in the router's handler to find the entity in a database by the provided accountId. This lets us get the corresponding API user credentials and use all three in the DLL Logon API call.

To get a clearer picture, let's define the managed Account entity as well:

@TypeAlias("Account") @Document(collection = "accounts") public class Account { @Version private Long version; /** * unique account ID for API, provided by supplier * defines restriction for data domain visibility * i.e. data from one account is not visible for another */ @Id private String accountId; /** * COM API username, provided by supplier */ private String apiUsername; /** * COM API password, provided by supplier */ private String apiPassword; @CreatedDate private Date createdAt; @LastModifiedDate private Date updatedOn; }

The JACOB Library Setup

All parts of our application are ready now except the core – the configuration and use of the JACOB library. Let's start with setting up the library.

The library is distributed via sourceforge.net. I did not find it available anywhere on either the Central Maven Repo or any other repositories online. So I decided to import it manually into our project as a local package.

To do that, I downloaded it and put it in the root folder under /libs/jacob-1.19.

After that, put the following maven-install-plugin configuration into pom.xml. This will add the library to the local repository during Maven's install build phase:

 org.apache.maven.plugins maven-install-plugin   install-jacob validate  ${basedir}/libs/jacob-1.19/jacob.jar default net.sf.jacob-project jacob 1.19 jar true   install-file    

That will let you easily add the dependency as usual:

 net.sf.jacob-project jacob 1.19 

The library import is finished. Now let's get it ready to use it.

To interact with the COM component, JACOB provides a wrapper called an ActiveXComponent class (as I mentioned before).

It has a method called invoke(String function, Variant... args) that lets us make exactly what we want.

Generally speaking, our library is set up to create the ActiveXComponent bean so we can use it anywhere we want in the app (and we want it in the implementation of DllApiService).

So let's define a separate Spring @Configuration with all the essential preparations:

@Slf4j @Configuration public class JacobCOMConfiguration { private static final String COM_INTERFACE_NAME = "NAME_OF_COM_INTERFACE_AS_IN_REGISTRY"; private static final String JACOB_LIB_PATH = System.getProperty("user.dir") + "\\libs\\jacob-1.19"; private static final String LIB_FILE = System.getProperty("os.arch") .equals("amd64") ? "\\jacob-1.19-x64.dll" : "\\jacob-1.19-x86.dll"; private File temporaryDll; static { log.info("JACOB lib path: {}", JACOB_LIB_PATH); log.info("JACOB file lib path: {}", JACOB_LIB_PATH + LIB_FILE); System.setProperty("java.library.path", JACOB_LIB_PATH); System.setProperty("com.jacob.debug", "true"); } @PostConstruct public void init() throws IOException { InputStream inputStream = new FileInputStream(JACOB_LIB_PATH + LIB_FILE); temporaryDll = File.createTempFile("jacob", ".dll"); FileOutputStream outputStream = new FileOutputStream(temporaryDll); byte[] array = new byte[8192]; for (int i = inputStream.read(array); i != -1; i = inputStream.read(array)) { outputStream.write(array, 0, i); } outputStream.close(); System.setProperty(LibraryLoader.JACOB_DLL_PATH, temporaryDll.getAbsolutePath()); LibraryLoader.loadJacobLibrary(); log.info("JACOB library is loaded and ready to use"); } @Bean public ActiveXComponent dllAPI() { ActiveXComponent activeXComponent = new ActiveXComponent(COM_INTERFACE_NAME); log.info("API COM interface {} wrapped into ActiveXComponent is created and ready to use", COM_INTERFACE_NAME); return activeXComponent; } @PreDestroy public void clean() { temporaryDll.deleteOnExit(); log.info("Temporary DLL API library is cleaned on exit"); } }

It's worth mentioning that, besides defining the bean, we initialize the library components based on the host machine's ISA (instruction set architecture).

Also, we follow some common recommendations to make a copy of the corresponding library's file. This avoids any potential corruption of the original file during runtime. We also need to cleanup all allocated resources when the applications terminates.

Now the library is set up and ready to use. Finally, we can implement our last main component that helps us interact with the DLL API:  DllApiServiceImpl.

How to Implement a DLL Library API Service

As all COM API calls are going to be cooked using a common approach, let's implement InitialiseWithID first. After that, all other methods can be implemented easily in a similar way.

Como mencionei antes, para interagir com a interface COM, o JACOB nos fornece a ActiveXComponentclasse que contém o invoke(String function, Variant... args)método.

Se você quiser saber mais sobre a Variantaula, a documentação do JACOB diz o seguinte (você pode encontrá-la no arquivo ou abaixo /libs/jacob-1.19no projeto):

O tipo de dados multiformato usado para todos os retornos de chamada e a maioria das comunicações entre Java e COM. Ele fornece uma única classe que pode lidar com todos os tipos de dados.

Isso significa que todos os argumentos definidos na InitialiseWithIDassinatura devem ser agrupados new Variant(java.lang.Object in)e passados ​​para o invokemétodo. Use a mesma ordem especificada na descrição da interface no início deste artigo.

The only other important thing we haven't touched on yet is how to distinguish in and out type arguments.

For that purpose, Variant provides a constructor that accepts the data object and information about whether this is by reference or not. This means that after invoke is called, all variants that were initialized as references can be accessed after the call. So we can extract the results from out arguments.

To do that, just pass an extra boolean variable to the constructor as the second parameter: new Variant(java.lang.Object pValueObject, boolean fByRef).

Initializing the Variant object as reference puts an additional requirement on the client to decide when to release the value (so it can be scrapped by the garbage collector).

For that purpose, you have the safeRelease() method that is supposed to be called when the value is taken from the corresponding Variant object.

Putting all the pieces together gives us the following service's implementation:

@RequiredArgsConstructor public class DllApiServiceImpl implements DllApiService { @Value("${DLL_API_ADDRESS}") private String address; private final ActiveXComponent dll; @Override public Mono
    
      initialiseWithID(final String accountId) { return Mono.just(format("Calling %s(%s, %s, %s, %s, %s, %s)",// InitialiseWithID, address, accountId, "loginId/out", "error/out", "outcome/out", "sessionId/out")) .doOnEach(logNext(log::info)) //invoke COM interface method and extract the result mapping it onto corresponding *Out inner class .map(msg -> invoke(InitialiseWithID, vars -> InitialiseWithIDOut.builder() .loginId(vars[3].toString()) .error(vars[4].toString()) .outcome(valueOf(vars[5].toString())) .sessionId(vars[6].toString()) .build(), // new Variant(address), new Variant(accountId), initRef(), initRef(), initRef(), initRef())) //Handle the response according to the documentation .map(out -> { final String errorVal; switch (out.outcome) { case 2: errorVal = "InitialiseWithID method call failed. DLL API request outcome (response code from server via DLL) = 2 " +// "(Unable to connect to server due to absent server, or incorrect details)"; break; case 3: errorVal = "InitialiseWithID method call failed. DLL API request outcome (response code from server via DLLe) = 3 (Unmatched AccountID)"; break; default: errorVal = handleOutcome(out.outcome, out.error, InitialiseWithID); } return of(out, errorVal); }) .doOnEach(logNext(t2 -> { InitialiseWithIDOut out = t2.getT1(); log.info("{} API call result:\noutcome: {}\nsessionId: {}\nerror: {}\nloginId: {}",// InitialiseWithID, out.outcome, out.sessionId, t2.getT2(), out.loginId); })) .map(t2 -> { InitialiseWithIDOut out = t2.getT1(); //out.outcome == 4 auto-login successful, SessionID is retrieved return of(out.outcome, out.outcome == 4 ? out.sessionId : out.loginId, t2.getT2()); }); } private static Variant initRef() { return new Variant("", true); } private static String handleOutcome(Integer outcome, String error, COM_API_Method method) { switch (outcome) { case 1: return "no error"; case 2: return format("%s method call failed. DLL API request outcome (response code from server via DLL) = 2 (Access denied)", method); default: return format("%s method call failed. DLL API request outcome (response code from server via DLL) = %s (server technical error). " + // "DLL API is temporary unavailable (server behind is down), %s", method, outcome, error); } } /** * @param method to be called in COM interface * @param returnFunc maps Variants (references) array onto result object that is to be returned by the method * @param vars arguments required for calling COM interface method * @param type of the result object that is to be returned by the method * @return result of the COM API method invocation in defined format */ private T invoke(COM_API_Method method, Function returnFunc, Variant... vars) { dll.invoke(method.name(), vars); T res = returnFunc.apply(vars); asList(vars).forEach(Variant::safeRelease); return res; } @SuperBuilder private static abstract class Out { final Integer outcome; final String error; } @SuperBuilder private static class InitialiseWithIDOut extends Out { final String loginId; final String sessionId; }
    

Two other methods, Logon and getMatchedUsers, are implemented accordingly. You can refer to my GitHub repo for a complete version of the service if you want to check it out.

Congratulations – You've Learned a Few Things

We've gone through a step by step scenario that showed us how a hypothetical COM API could be distributed and called in Java.

We also learned how the JACOB library can be configured and effectively used to interact with a DDL library within your Spring Boot 2 application.

Uma pequena melhoria seria armazenar em cache o SessionID recuperado, o que poderia melhorar o fluxo geral. Mas isso está um pouco fora do escopo deste artigo.

Se você quiser investigar mais, pode encontrar isso no GitHub, onde é implementado usando o mecanismo de cache do Spring.

Espero que você tenha gostado de passar por tudo comigo e tenha achado este tutorial útil!