Projetando código efetivo orientado a objetos

Definição de interfaces

Objective

After completing this lesson, you will be able to definir interfaces.

Definição de interface

Motivos para utilizar interfaces

Interfaces permitem que você defina como um programa abordará uma ou mais classes. Em uma interface, você pode definir métodos, atributos, tipos e constantes, tal como faria em uma classe. Esses componentes formam uma descrição de como um programa client pode interagir com os objetos correspondentes. No entanto, uma interface não pode ser instanciada, e não contém implementações de seus métodos. Para que o conceito funcione, também necessitamos de uma ou mais classes que implementem a interface. Isso significa que elas incluem a interface em sua própria declaração de classe, e os componentes que são declarados na interface fazem parte da própria classe. Se a interface contiver declarações de método, a classe que implementa a interface também deve fornecer uma implementação desses métodos.

Interfaces têm duas importantes funções:

Fornecer uma abordagem unificada para diferentes classes: se você tiver classes que não estão relacionadas por herança, mas que ainda devem fornecer serviços comuns aos seus usuários, você pode definir os serviços comuns em uma interface. Isso garantirá que cada classe forneça um método com o mesmo nome e a mesma assinatura para executar tarefa particular. Programas que utilizam as classes, têm, então, uma única forma para chamar funções particulares, independentemente de que classe estejam realmente abordando.

Fornecer uma abordagem simplificada para uma classe complexa: como você verá mais tarde, as interfaces fornecem uma visão restrita de um objeto. Isso permite que você exponha um conjunto específico de métodos a um programa que utilizará uma determinada classe com base nas funções que o programa realmente necessita.

Veja este exemplo para saber como uma interface funciona.

Definição de interface

A definição de uma interface é muito semelhante à seção de definição de uma classe. No entanto, uma vez que uma interface não tem uma implementação, não há suplemento DEFINITION na instrução INTERFACE. A segunda grande diferença é que não existem áreas de visibilidade em uma interface, já que todos os componentes de uma interface são públicos. As interfaces são úteis, devido à sua interação com outras classes, de modo que não faz sentido ter componentes não públicos.

Na definição da interface, você pode utilizar tipos, atributos, constantes e métodos, e são permitidos os componentes de instância e estáticos. Lembre-se de que métodos de interface tem uma definição, mas nenhuma implementação. Isso será fornecido pela classe de implementação.

De muitas maneiras, as interfaces são semelhantes às superclasses abstratas. Elas fornecem uma técnica útil para casos nos quais é necessário definir componentes comuns para classes sem que haja um caso para herança. Em outras palavras, quando não há relação clara "é um".

Implementação da interface

Para implementar uma interface em uma classe, utilize a instrução INTERFACES. Como todos os componentes da interface são públicos e você não pode modificar a visibilidade de um componente existente, você deve incluir a interface na seção pública da classe.

Assim que você tiver gravado a instrução INTERFACES, seu programa estará sintaticamente incorreto. Isso ocorre porque a interface contém um método que você ainda não implementou. Você pode utilizar uma solução rápida (Ctrl + 1) para adicionar a implementação do método à sua classe.

Quando você declara uma interface em uma classe, deve implementar todos os seus métodos.

Na implementação da sua classe, você deve implementar todos os métodos declarados na interface. Quando você nomeia o método na implementação, deve usar o nome totalmente qualificado, que consiste no nome da interface e no nome do método unidos por um til. Isso porque não há garantia de que o nome do método seja inambíguo por si só. Lembre-se de que os nomes de componentes só devem ser exclusivos na classe ou na interface na qual estão declarados. Consequentemente, uma classe pode declarar um método chamado get_partner_attributes, bem como a interface lif_partner.

Testar: definição de interface

  1. Crie uma nova classe que implemente a interface IF_OO_ADT_CLASSRUN.
  2. Mude para a guia Tipos locais e copie o seguinte snippet de código para o editor:
    Code Snippet
    123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
    INTERFACE lif_partner. METHODS get_partner_attributes. ENDINTERFACE. CLASS lcl_travel_Agency DEFINITION. PUBLIC SECTION. ENDCLASS. CLASS lcl_airline DEFINITION. PUBLIC SECTION. INTERFACES lif_Partner. TYPES: BEGIN OF ts_detail, name TYPE string, value TYPE string, END OF ts_detail, tt_Details TYPE SORTED TABLE OF ts_detail WITH UNIQUE KEY name. METHODS get_details RETURNING VALUE(rt_details) TYPE tt_details. ENDCLASS. CLASS lcl_car_Rental DEFINITION. PUBLIC SECTION. interfaces lif_Partner. TYPES: BEGIN OF ts_info, name TYPE c LENGTH 20, value TYPE c LENGTH 20, END OF ts_info, tt_Info TYPE SORTED TABLE OF ts_info WITH UNIQUE KEY name. METHODS get_information RETURNING VALUE(rt_details) TYPE tt_info. ENDCLASS. CLASS lcl_airline IMPLEMENTATION. METHOD get_details. ENDMETHOD. METHOD lif_partner~get_partner_attributes. ENDMETHOD. ENDCLASS. CLASS lcl_car_rental IMPLEMENTATION. METHOD get_information. ENDMETHOD. METHOD lif_partner~get_partner_attributes. ENDMETHOD. ENDCLASS.
  3. Pressione Ctrl + F3 para ativar a classe.
  4. Familiarize-se com o código.

    Nota

    Não há código executável neste exemplo.

Definir e implementar uma interface

Você percebe que o método GET_OUTPUT na classe local LCL_CARRIER e o método GET_DESCRIPTION na classe local LCL_FLIGHT são muito semelhantes. Para harmonizar a definição, você introduz uma interface e implementa a mesma em ambas as classes.

Modelo:

  • /LRN/CL_S4D401_OOS_INH_USAGE (classe global)

Solução:

  • /LRN/CL_S4D401_OOS_INTERFACE (classe global)

Tarefa 1: Copiar modelo (opcional)

Copie a classe modelo /LRN/CL_S4D401_OOS_INH_USAGE. Se você tiver concluído o exercício anterior, pode ignorar esta tarefa e continuar processando sua classe ZCL_##_SOLUTION.

Etapas

  1. Copie a classe /LRN/CL_S4D401_OOS_INH_USAGE para uma classe em seu próprio pacote (nome sugerido: ZCL_##_SOLUTION, onde ## representa seu número de grupo).

    1. No Explorador de projetos, clique com o botão direito do mouse na classe /LRN/CL_S4D401_OOS_INH_USAGE para abrir o menu de contexto.

    2. No menu de contexto, selecione Duplicar....

    3. Insira o nome do seu pacote no campo Pacote. No campo Nome, insira ZCL_##_SOLUTION, em que ## representa seu número de grupo.

    4. Selecione Avançar.

    5. Confirme a ordem de transporte e selecione Concluir.

  2. Ative a cópia.

    1. Pressione Ctrl + F3 para ativar a classe.

Tarefa 2: Definir a interface

Defina uma interface local (nome sugerido: LIF_OUTPUT) e implemente a mesma nas classes locais LCL_FLIGHT e LCL_CARRIER.

Nota

Deixe a interface em branco por enquanto. Adicionaremos componentes de interface na próxima tarefa.

Etapas

  1. Em sua classe global, navegue para a definição da classe local LCL_FLIGHT.

    1. Por exemplo, selecione o nome da classe na visão Estrutura.

  2. Na seção pública, adicione uma declaração que declare a implementação da interface LIF_OUTPUT ainda não existente.

    1. Ajuste o código da seguinte forma:

      ABAP
      1234
      CLASS lcl_flight DEFINITION ABSTRACT. PUBLIC SECTION. INTERFACES lif_output.
  3. Utilize uma correção rápida para criar a interface LIF_OUTPUT como interface local.

    1. Na instrução INTERFACES, posicione o cursor em lif_output e pressione Ctrl + 1 para chamar as soluções rápidas disponíveis.

    2. A partir da lista de soluções rápidas disponíveis, selecione Criar interface local lif_output.

      Resultado

      A correção rápida gera o seguinte código:
      ABAP
      123
      INTERFACE lif_output. ENDINTERFACE.
  4. Implemente a nova interface também na classe local LCL_CARRIER.

    1. Navegue para a definição da classe local LCL_CARRIER.

    2. Adicione o seguinte código abaixo da instrução PUBLIC SECTION:

      ABAP
      1
      INTERFACES lif_output.

Tarefa 3: Implementar métodos de interface

Desloque a definição do método de instância GET_OUTPUT da classe LCL_CARRIER para a interface LIF_OUTPUT. Em seguida, implemente a interface na classe local LCL_FLIGHT, onde você delega a solicitação ao método GET_DESCRIPTION.

Etapas

  1. Utilize um método de correção rápida para deslocar (pull up) GET_OUTPUT da classe local LCL_CARRIER para a interface local LIF_OUTPUT.

    Nota

    Ignore o aviso de que o método se refere a outros componentes da classe.
    1. Na classe local LCL_CARRIER, navegue para a definição do método de instância GET_OUTPUT.

    2. Na instrução METHODS, posicione o cursor em get_output e pressione Ctrl + 1 para chamar as soluções rápidas disponíveis.

    3. A partir da lista de soluções rápidas disponíveis, selecione Pull-Up get_output para a interface lif_output.

    4. Leia a advertência cuidadosamente e, em seguida, selecione Continuar.

    Resultado

    A solução rápida elimina a definição do método GET_OUTPUT da classe LCL_CARRIER e adiciona o método à interface:
    ABAP
    1234
    INTERFACE lif_output. METHODS get_output RETURNING VALUE(r_result) TYPE tt_output. ENDINTERFACE.
    Além disso, o nome do método na parte de implementação da classe LCL_CARRIER é adaptado ao nome completo do método de interface:
    ABAP
    123456
    METHOD lif_output~get_output. APPEND |{ 'Carrier Name:'(001) } { me->name }| TO r_result. APPEND |{ 'Passenger Flights:'(002) } { pf_count }| TO r_result. APPEND |{ 'Average free seats:'(003) } { get_average_free_seats( ) }| TO r_result. APPEND |{ 'Cargo Flights:'(004) } { cf_count }| TO r_result. ENDMETHOD.
    Por fim, a solução rápida cria o alias get_output para o método de interface lif_output~get_output na seção pública da classe LCL_CARRIER:
    ABAP
    1
    ALIASES: get_output FOR lif_output~get_output.
  2. Analise o novo erro de sintaxe na visão Problemas.

    1. Abra a visão Problemas, que está localizada abaixo do editor.

  3. Use a assistência rápida para mover (puxar para cima) os tipos TT_OUTPUT e T_OUTPUT da classe local LCL_CARRIER para a interface LIF_OUTPUT.

    1. Na classe local LCL_CARRIER, navegue para a definição do tipo TT_OUTPUT.

    2. Na instrução TYPES, posicione o cursor em tt_output e pressione Ctrl + 1 para chamar as soluções rápidas disponíveis.

    3. A partir da lista de soluções rápidas disponíveis, selecione Pull-Up tt_output para a interface lif_output.

    4. Selecione Continuar para ignorar o aviso relacionado ao tipo T_OUTPUT.

    5. Repita as etapas anteriores para puxar o tipo T_OUTPUT para a interface.

  4. Se necessário, ajuste a sequência dos tipos TT_OUTPUT e T_OUTPUT na definição da interface.

    1. A definição de interface deve ter o seguinte aspecto:

      ABAP
      12345678
      INTERFACE lif_output. TYPES t_output TYPE string. TYPES tt_output TYPE STANDARD TABLE OF t_output WITH NON-UNIQUE DEFAULT KEY. METHODS get_output RETURNING VALUE(r_result) TYPE tt_output. ENDINTERFACE.
  5. Utilize uma correção rápida para adicionar a implementação em falta do método de interface GET_OUTPUT na classe local LCL_FLIGHT.

    1. Navegue para a definição da classe local LCL_FLIGHT.

    2. Na instrução INTERFACES, posicione o cursor em lif_output e pressione Ctrl + 1. Em alternativa, selecione o ícone de erro com a lâmpada no lado esquerdo da linha de código.

    3. A partir da lista de soluções rápidas, selecione Adicionar implementação para get_output.

  6. No método adicionado lif_output~get_output, implemente uma chamada do método de instância get_description e armazene o resultado no parâmetro de retorno r_result.

    1. Ajuste o código da seguinte forma:

      ABAP
      123
      METHOD lif_output~get_output. r_result = get_description( ). ENDMETHOD.
  7. Ative e teste sua classe global como aplicativo de console.

    1. Pressione Ctrl + F3.

    2. Pressione F9.