Qoder CN Series:Melhores práticas para uso de base de conhecimento como contexto na conclusão de código

Cenários de backend

• [Recomendado] Selecione trechos ou arquivos de código de alta frequência: Escolha trechos de código frequentes ou reutilizados no projeto atual. Esses trechos possuem alta reusabilidade e são adequados para inclusão em uma base de conhecimento. Organize-os em um repositório separado e envie-os para uma base de conhecimento separada para facilitar o gerenciamento e a recuperação.

• Código do projeto atual: Envie todo o projeto atual para uma base de conhecimento para permitir uma recuperação abrangente. Isso melhora a reusabilidade do código e a eficiência do desenvolvimento. No entanto, se o projeto contiver código interferente ou de baixa qualidade, o desempenho da melhoria de conclusão de código pode ser afetado.

Cenários de frontend

• [Recomendado] Repositório de código de páginas de modelo de frontend: Monte componentes personalizados da empresa em modelos para páginas frontend altamente reutilizáveis, como páginas de login, registro, exibição de conta e transferência de fundos. Se sua empresa possui uma biblioteca de modelos, envie-a para a base de conhecimento de código corporativo.

• Repositório de código do projeto atual: Envie código de projeto bem estruturado e de alta qualidade para a base de conhecimento corporativa para permitir uma recuperação abrangente. Código de baixa qualidade ou interferente no repositório pode afetar o desempenho da conclusão de código.

Caso 1: Reutilização de lógica de framework e middleware corporativos

Uma empresa precisa de um mecanismo unificado de bloqueio distribuído para seu sistema de gestão de estoque. Integre frameworks de negócio à base de conhecimento de código. Assim, os desenvolvedores podem usar facilmente esses trechos de código ao escrever novo código nas IDEs. Essa prática aumenta a eficiência do desenvolvimento, reduz retrabalho, melhora a qualidade do código e garante a consistência da lógica de negócio.

Siga estas dicas para selecionar e preparar um repositório de código:

Identifique as necessidades de negócio e implementações necessárias:

• Identifique módulos de negócio essenciais que exigem implementação unificada no sistema, como controle de estoque, processamento de pedidos e sistemas de pagamento.

• Defina como lidar com cenários de negócio específicos: Por exemplo, o sistema de estoque possui tarefas diferentes, como redução de estoque, verificação de nível de estoque e bloqueio de estoque. Cada tarefa requer um mecanismo de implementação distinto.

Escolha arquivos de código dos frameworks de negócio e envie-os para uma base de conhecimento de código:

• Filtre os frameworks de negócio para encontrar o código principal que lida com a lógica de negócio essencial, organize-o e envie-o para uma base de conhecimento de código separada. Por exemplo, se for necessário bloqueio distribuído para manter a segurança durante atualizações, localize o código principal que implementa esse bloqueio.

  /**
   * Use the enterprise-developed distributed locking mechanism to implement concurrency control
   */
  @Service
  public class InventoryService {
      
      @Autowired
      private DistributedLockFramework lockFramework;
      
      @Autowired
      private InventoryRepository inventoryRepository;
      
      /**
       * Use the distributed locking mechanism to ensure concurrency security during inventory deduction
       * @param productId, which specifies the product ID.
       * @param quantity, which specifies the deduction quantity.
       * @return, which specifies whether deduction is successful.
       */
      public boolean deductInventory(Long productId, int quantity) {
          String lockKey = "inventory:" + productId;
          return lockFramework.withLock(lockKey, 30, TimeUnit.SECONDS, () -> {
              Inventory inventory = inventoryRepository.findByProductId(productId);
              if (inventory == null || inventory.getQuantity() < quantity) {
                  return false;
              }
              inventory.setQuantity(inventory.getQuantity() - quantity);
              inventoryRepository.save(inventory);
              return true;
          });
      }
  }

Caso 2: Reutilização de lógica de negócio central da empresa

Uma empresa deseja estabelecer uma política única e personalizada de recomendação para seus produtos. Nesse caso, integre frameworks de negócio desenvolvidos pela empresa a uma base de conhecimento de código corporativa. Dessa forma, os desenvolvedores podem recuperar e reutilizar facilmente trechos de código padronizados ao escrever lógica de negócio em uma IDE. Isso aumenta a eficiência do desenvolvimento, reduz retrabalho, melhora a qualidade do código e garante a consistência e estabilidade da lógica de negócio.

Siga estas dicas para selecionar e preparar um repositório de código:

Determine os módulos de negócio e implementações necessários:

• Identifique módulos de negócio essenciais: Encontre as partes do negócio que precisam de implementação unificada no sistema, como o sistema de recomendação de produtos.

• Defina ações de negócio e etapas principais. Por exemplo, uma política de recomendação personalizada inclui estas etapas: coletar dados de comportamento do usuário, identificar características de interesse do usuário, obter uma lista de produtos possíveis, pontuar e classificar esses produtos e exibir as principais escolhas. Use código pré-escrito para implementar essas etapas.

Escolha arquivos de código dos frameworks de negócio e envie-os para uma base de conhecimento de código:

• Encontre o código principal que lida com a lógica de negócio essencial, organize-o e envie-o para uma base de conhecimento de código separada. Veja um exemplo de política de recomendação personalizada:

  /**
   * The recommendation engine service
   * Implement personalized recommendation based on user behavior and commodity features
   */
  @Service
  public class RecommendationService {
      
      @Autowired
      private UserBehaviorRepository userBehaviorRepo;
      
      @Autowired
      private ProductRepository productRepo;
      
      /**
       * Generate a recommendation list for a specified user
       * @param userId, which specifies the user ID.
       * @param limit, which specifies the maximum number of commodities that can be recommended.
       * @return, which specifies the IDs of recommended commodities.
       */
      public List generateRecommendations(Long userId, int limit) {
          // Obtain user behavior data
          List behaviors = userBehaviorRepo.findRecentByUserId(userId, 100);
          
          // Extract user interest features
          Map userInterests = extractUserInterests(behaviors);
          
          // Obtain a candidate commodity pool
          List candidateProducts = productRepo.findRecentlyActive(1000);
          
          // Calculate and rank commodity scores
          List scoredProducts = candidateProducts.stream()
              .map(product -> new ScoredProduct(product, calculateScore(product, userInterests)))
              .sorted(Comparator.comparing(ScoredProduct::getScore).reversed())
              .collect(Collectors.toList());
          
          // Return the top-scoring commodities
          return scoredProducts.stream()
              .limit(limit)
              .map(sp -> sp.getProduct().getId())
              .collect(Collectors.toList());
      }
      
      // Other auxiliary methods
  }

Caso 3: Referenciar projetos existentes para melhorar a eficiência de novos projetos

Quando uma empresa inicia um novo projeto, ela pode aproveitar o código de módulos centrais semelhantes de um projeto existente. Essa estratégia economiza tempo e recursos, além de tornar o novo projeto melhor e mais estável.

Siga estas dicas para selecionar e preparar um repositório de código:

Identifique módulos de negócio essenciais com base nos requisitos de negócio e cenários:

• Identifique funções ou métodos semelhantes. Por exemplo, se tanto o projeto novo quanto o antigo possuem funções como gerenciamento de usuários, exibição de produtos e processamento de pedidos, liste os módulos relacionados.

• Verifique a qualidade do código: Garanta que o código do projeto existente tenha sido totalmente testado e seja estável e confiável. Remova arquivos e configurações desnecessários para manter o código limpo e fácil de usar.

Defina ações de negócio específicas e ações centrais:

• Extraia funções centrais: Do projeto existente, extraia o código de módulos funcionais chave que possam ser reutilizados. Exemplos:

  • Gerenciamento de usuários: registro de usuário, login e modificação de informações

  • Exibição de produtos: lista de produtos, página de detalhes e função de busca

  • Processamento de pedidos: realização de pedido, processamento de pagamento e atualização de status do pedido

Escolha arquivos de código dos frameworks de negócio relacionados e envie-os para uma base de conhecimento de código. Reorganize o código do projeto existente usando uma estrutura modular. Isso separa o código para diferentes equipes responsáveis por módulos específicos no novo projeto. Crie um repositório de código separado para cada módulo:

• Isolamento da base de conhecimento de código: Envie o código do projeto existente para a base de conhecimento apropriada. Por exemplo, envie o código dos módulos de gerenciamento de usuários, exibição de produtos e processamento de pedidos para bases de conhecimento separadas.

• Gerenciamento de permissões: Configure permissões para que apenas as equipes corretas acessem códigos específicos. Isso evita interferências durante a conclusão de código nas IDEs.