O DataWorks Open Platform disponibiliza exemplos de código para cenários de aplicação específicos, facilitando a compreensão e o uso dos diversos recursos da plataforma, como OpenAPI, OpenEvent e Extensions. Este tópico descreve como executar os códigos de exemplo obtidos no GitHub na sua máquina local, demonstrando as capacidades de plataforma aberta do DataWorks em diferentes cenários de negócios.
Informações de contexto
O DataWorks Open Platform oferece os módulos OpenAPI, OpenEvent e Extensions. Use esses módulos para integrar o DataWorks aos seus aplicativos e assinar mensagens de eventos. Eles permitem interconectar diversos sistemas ao DataWorks para controle de processos de dados, governança de dados e operação e manutenção. Além disso, eles permitem responder rapidamente a mudanças no status dos negócios de vários sistemas. Para obter mais informações sobre o Open Platform, consulte Overview.
Inicialização do projeto
Etapa 1: Preparar o ambiente de desenvolvimento
-
Instale o Java Development Kit (JDK).
Para instalar o JDK, acesse o site oficial da Oracle e baixe o JDK com uma versão compatível com o seu sistema operacional.
NotaNeste exemplo, a versão do JDK deve ser Java 1.8 ou posterior. Após concluir a instalação, abra o Prompt de comando ou um terminal e execute o comando
java -versionpara verificar a versão do Java. -
Instale o Maven.
O Maven é uma ferramenta para o ambiente de execução Java. Acesse o site oficial do Maven e baixe o pacote compatível com o seu sistema operacional. Após concluir o download, consulte Installing Apache Maven para descompactar o pacote e instalar o Maven.
-
Instale o Node.js.
Este exemplo utiliza uma página de frontend. Portanto, instale o ambiente Node.js no cliente para executar códigos JavaScript. Para isso, acesse o site oficial do Node.js e baixe o instalador.
NotaNeste exemplo, a versão do Node.js deve ser superior a 14. Após concluir a instalação, abra o Prompt de comando ou um terminal e execute o comando
node --versionpara verificar a versão do Node.js. -
Instale o pnpm.
O pnpm é uma ferramenta de gerenciamento de pacotes para projetos JavaScript. Neste exemplo, a biblioteca de códigos de exemplo usa o workspace mode para evitar que componentes comuns sejam enviados ao npm. Por isso, é necessário instalar o pnpm. Clique em Installation para instalar a ferramenta pnpm. Caso já tenha instalado o Node.js, execute o seguinte comando para instalar o pnpm:
npm install -g pnpm -
Verifique o ambiente de desenvolvimento.
Após concluir as etapas anteriores, execute os comandos abaixo para verificar se o ambiente necessário para este exemplo está instalado:
java -version // If JDK is installed, the command output shows the JDK version. Otherwise, the "command not found" error is reported. mvn -v // If Maven is installed, the command output shows the Maven version. Otherwise, the "command not found" error is reported. npm -v // If Node.js is installed, the command output shows the Node.js version. Otherwise, the "command not found" error is reported. pnpm -v // If pnpm is installed, the command output shows the pnpm version. Otherwise, the "command not found" error is reported.
Etapa 2: Executar o código de exemplo
-
Instale as dependências.
Após preparar o ambiente de desenvolvimento, baixe o projeto de exemplo para a sua máquina local e execute o seguinte código para instalar as dependências:
pnpm install -
Insira o seu AccessKey ID e o AccessKey secret.
Após concluir a instalação, localize o arquivo de configuração application.properties no diretório raiz. Nesse arquivo, especifique informações essenciais como Access Key (AK), Secret Key (SK), Region-id e endpoint. O projeto lê e sincroniza essas informações com cada aplicativo de exemplo durante a inicialização.
NotaAo executar o projeto, as informações essenciais especificadas no arquivo de configuração serão usadas para se conectar aos módulos do DataWorks Open Platform.
## The AccessKey ID of a RAM user. api.access-key-id={access-key} ## The AccessKey secret of a RAM user. api.access-key-secret={secret-key} ## The ID of the region where the DataWorks service is deployed. Sample values: cn-shanghai and cn-hangzhou. # api.region-id=cn-hangzhou api.region-id={regionId} ## The service of DataWorks API operations. The default value is dataworks-public. api.product=dataworks-public ## The endpoint of DataWorks OpenAPI. ## If DataWorks OpenAPI is accessed over the Internet, the endpoint is in the format of dataworks.${regionId}.aliyuncs.com. By default, DataWorks OpenAPI is accessed over the Internet. ## If DataWorks OpenAPI is accessed over a virtual private cloud (VPC), the endpoint is in the format of dataworks-vpc.${regionId}.aliyuncs.com. # api.endpoint=dataworks.cn-hangzhou.aliyuncs.com api.endpoint={endpoint} ## Specify the network environment. For access over the Internet, set the parameter to false. For access over a VPC, set the parameter to true. api.vpc-env=false -
Execute o código de exemplo.
Após concluir as configurações anteriores, execute os comandos a seguir para executar o código de exemplo.
npm run example:workbench-screen // Execute the sample code for Operation Center. npm run example:meta-api // Execute the sample code for metadata. npm run example:event-instance-status // Execute the sample code for subscribing to the status change events of an auto triggered node instance. npm run example:extension-maxpt // Execute the sample code for prohibiting the use of the MAX_PT function. npm run example:extension-deploy-control // Execute the sample code for configuring the settings in DataWorks Open Platform to perform a lockdown. -
Visualize o resultado da execução.
Após a execução do código, visualize os resultados em um navegador.
-
Para exemplos com uma página de frontend interativa, acesse a página por meio da seguinte URL:
https://localhost:8080 -
Para exemplos apenas de backend, acesse o backend por meio da seguinte URL:
http://localhost:8008
-
Obter o código de exemplo para um cenário de aplicação
Obtenha os códigos de exemplo para os seguintes cenários na biblioteca de códigos de exemplo do Open Platform: