Estrutura do Diretório e Visão Geral do Projeto
A estrutrua de diretórios do SDK é organizada da seguinte forma:
cos-wx-sdk-v5/
├── exemplo/
│ ├── lib/
│ │ └── cos-wx-sdk-v5.js
│ └── ...
├── dist/
│ ├── cos-wx-sdk-v5.js
│ └── cos-wx-sdk-v5.min.js
├── src/
│ ├── cos-wx-sdk-v5.js
│ └── ...
├── .gitignore
├── LICENSE
├── README.md
└── package.json
Descrição das pastas e arquivos principais:
exemplo/: Contém o código de um aplicativo de exemplo (Mini Program).exemplo/lib/: Local onde o arquivo do SDK deve ser colocado para uso na aplicação.dist/: Contém os artefatos de distribuição compilados.dist/cos-wx-sdk-v5.js: Versão não minificada do SDK.dist/cos-wx-sdk-v5.min.js: Versão minificada para ambiente de produção.src/: Código-fonte original do SDK.package.json: Arquivo de configuração do projeto com metadados, scripts e dependências.
Integração do SDK no Seu Projeto
Para utilizar o SDK, você deve copiar a versão apropriada (desenvolvimento ou produção) para o diretório lib do seu Mini Program. A importação é feita via require.
// Para desenvolvimento
const CloudObjectStorage = require('./lib/cos-wx-sdk-v5.js');
// Para produção (versão minificada)
// const CloudObjectStorage = require('./lib/cos-wx-sdk-v5.min.js');
Após a importação, a instância da classe principal do SDK (CloudObjectStorage) está disponível para ser configurada e utilizada.
Análise do Arquivo de Configuração (package.json)
O arquivo package.json gerencia as configurações do projeto. Um exemplo simplificado segue abaixo:
{
"nome": "cos-wx-sdk-v5",
"versao": "1.0.0",
"descricao": "SDK para interação com o serviço de armazenamento de objetos da nuvem através de uma API XML, otimizado para Mini Programs.",
"principal": "dist/cos-wx-sdk-v5.js",
"scripts": {
"construir": "webpack",
"verificar": "echo \"Nenhum teste especificado\" && exit 1"
},
"palavras-chave": ["cos", "armazenamento-objeto", "mini-program", "api-xml"],
"autor": "tencentyun",
"licenca": "MIT",
"dependencias": {},
"devDependencias": {
"webpack": "^4.0.0",
"webpack-cli": "^3.0.0"
}
}
Campos importantes:
principal: Define o ponto de entrada do pacote.scripts: Permite executar tarefas automatizadas, como a compilação comwebpackusandonpm run construir.dependencias: Neste caso, o SDK não possui dependências de tempo de execução, pois é autocontido.devDependencias: Inclui ferramentas necessárias apenas para o processo de desenovlvimento e build do SDK.