Diretrizes:  Interface

Interface

É um elemento do modelo que define um conjunto de comportamentos (um conjunto de operações) oferecido por um elemento do modelo classificador (principalmente uma classe, um subsistema ou um componente). Um classificador pode realizar uma ou mais interfaces. Uma interface pode ser realizada por um ou mais classificadores. Os classificadores que realizem as mesmas interfaces podem ser substituídos uns pelos outros no sistema. Cada interface deve fornecer um conjunto exclusivo e bem definido de operações.

Tópicos

• Nomeação de Interfaces
• Descrição de Interfaces
• Definição de Operações
• Documentação de Interfaces
• Dicas

Nomeação de Interfaces

• Nomeie a interface a fim de refletir o papel que ela desempenha no sistema.
• O nome deve ser curto, com uma ou duas palavras.
• Não inclua a palavra "interface" no nome; isso já está implícito pelo tipo de elemento do modelo (por exemplo, interface)

Descrição de Interfaces

• A descrição deve indicar as responsabilidades da interface.
• A descrição deve conter várias frases, formando no máximo um parágrafo curto.
• A descrição não deve apenas reafirmar o nome da interface, mas sim esclarecer o papel que ela desempenha no sistema.

Definição de Operações

• Os nomes de operação devem refletir o resultado da operação.
• Quando uma operação define ou obtém informações, a inclusão de definir ou obter no nome correspondente é redundante. Atribua à operação o mesmo nome da propriedade do elemento do modelo que está sendo definido ou recuperado. Uma operação nomeada dessa forma, sem parâmetros, recupera a propriedade; uma operação nomeada dessa forma, com um parâmetro , define a propriedade.

Exemplo

name() retorna o nome do objeto; name(aString) define o nome do objeto como aString.

• A descrição da operação deve mencionar o que ela faz, incluindo os principais algoritmos, e qual valor ela retorna.
• Nomeie os parâmetros da operação para que indiquem as informações que estão sendo transmitidas para ela.
• Identifique o tipo do parâmetro.

Documentação de Interfaces

O comportamento definido pela Interface é especificado como um conjunto de Operações. Talvez seja necessário fornecer informações adicionais:

• Como as operações são usadas e a ordem de execução correspondente (mostrada por diagramas de seqüência de exemplo).
• Os possíveis estados observáveis externamente nos quais pode estar o elemento do modelo que realiza a interface (mostrados por uma máquina de estado; consulte Diretrizes: Diagrama de Estados).
• Planos de teste e scripts que testam o comportamento de qualquer elemento do modelo que realize a interface.

Para agrupar e gerenciar essas informações, é necessário criar um pacote para conter a interface e todos os artefatos relacionados.

Dicas

Toda interface representa uma 'junção' no sistema: um local do qual ele pode ser "extraído" e reconstruído ou projetado novamente. As interfaces representam a separação da especificação do design ou da implementação. As interfaces bem estruturadas:

• são simples mas completas, fornecendo todas as operações necessárias mas suficientes para especificar um único serviço
• são compreensíveis, fornecendo informações suficientes para usar e realizar a interface sem que seja necessário examinar um uso ou uma implementação existente
• são acessíveis, fornecendo informações que orientam o usuário para as principais propriedades sem importuná-los com os detalhes das operações

Ao projetar uma interface,

• use a notação de "pirulito" sempre que precisar especificar apenas a presença de uma junção no sistema. Na maioria das vezes, isso será usado em componentes, não em classes.
• Use a notação de "classe" expandida quando precisar apresentar os detalhes de serviço. Na maioria das vezes, isso será usado para especificar os serviços oferecidos por um pacote ou um subsistema.

Copyright  © 1987 - 2001 Rational Software Corporation

Rational Unified Process