Kotlin - Orienta��o a Objetos: Classes

Fique por dentro

Essa � uma introduç�o �s classes em Kotlin. Atrav�s de exemplos, apresentaremos neste artigo como escapar de algumas armadilhas ao trabalhar com classes e veremos como interpretar e corrigir erros comuns emitidos pelo compilador referentes a construtores e blocos de inicializaç�o.

Kotlin: Classes

Declaraç�o de classes
Construtores
Construtores e propriedades
Imutabilidade dos par�metros dos construtores secund�rios
Instanciando uma classe
Funç�es membro
Construtores e blocos de inicializaç�o
N�veis de acesso

Artigos da S�rie Kotlin

Kotlin: Herança

Kotlin n�o � uma linguagem em que todo o c�digo precisa estar contido em uma classe. Ela incorpora a programaç�o procedural e funcional e, caso seja necess�rio, se pode utilizar os objetos nativos, implementando as regras de neg�cio do projeto com funç�es. Por�m, quando trabalhamos de forma orientada a objetos nessa linguagem devemos nos atentar para os diversos recursos que ela disp�e para a escrita de classes, assunto tratado aqui.

Uma classe � um bloco de construç�o de software fundamental, encontrado na grande maioria das linguagens orientadas a objetos e, dessa forma, tamb�m presente em Kotlin. Elas s�o usadas para criar novos tipos de dados, utilizando uma estrutura composta por m�todos e vari�veis que podem possuir os seus pr�prios tipos.

Abaixo, na Figura 1 vemos uma vis�o geral da estrutura de uma classe em Kotlin.

Figure 1. Estrutura de uma classe

Ao longo desse artigo explicaremos esses elementos e alguns outros.

Declaraç�o de classes

Em Kotlin, um arquivo pode conter diferentes declaraç�es de classes, as quais s�o feitas utilizando a palavra reservada class. Abaixo apresentamos uma declaraç�o de classe feita da forma mais simples poss�vel em Kotlin.


class Medicamento

No exemplo acima, uma vez que a classe Medicamento n�o possui um corpo, podemos omitir as chaves que estariam na frente do seu nome.

Construtores

Um construtor � uma funç�o especial da classe, utilizada na criaç�o e inicializaç�o dos objetos derivados dela.

Kotlin distingue os construtores de uma classe entre prim�rios e secund�rios. O construtor prim�rio de uma classe faz parte do seu cabeçalho e pode conter apenas uma lista de par�metros, assim como apresentado abaixo.


class Medicamento(val formula: String, val posologia: String)

Dado que o construtor prim�rio n�o pode conter nenhum c�digo, uma classe pode conter um ou mais blocos de inicializaç�o, que s�o executados na ordem como s�o declarados no corpo da mesma. Nesses blocos de inicializaç�o, conforme visto no C�digo 1, podemos acessar quaisquer par�metros que estejam presentes no construtor prim�rio. A relaç�o entre construtor prim�rio e propriedades ser� detalhada ainda neste artigo.


class Medicamento(val formula: String, val posologia: String) {
     init {
         require(formula.trim().length > 0) {
            "Informe uma f�rmula"
         }

         require(posologia.trim().length > 0) {
            "Informe uma posologia"
         }
     }
}

C�digo 1. Blocos de inicializaç�o

Al�m do construtor prim�rio, uma classe tamb�m pode declarar um ou mais construtores secund�rios. Esses, por sua vez, sempre devem utilizar a palavra reservada constructor em suas declaraç�es, mesmo quando um modificador de acesso for omitido ou nenhuma anotaç�o for utilizada, como mostra o C�digo 2.


class Medicamento {
    constructor(formula: String, posologia: String)
}

C�digo 2. Construtor secund�rio

No caso de uma classe possuir mais de um construtor, sendo um deles prim�rio, cada construtor secund�rio deve delegar ao construtor prim�rio. Quando ambos os construtores estiverem na mesma classe, a delegaç�o de um construtor para o outro � feita com a palavra reservada this.

Podemos utilizar valores padr�o do construtor delegado de uma classe. Para demonstrar isso vamos adicionar um terceiro par�metro no construtor para a contraindicaç�o do medicamento. Considerando que a classe Medicamento possa ser inicializada sem um valor para essa propriedade, caso no qual o mesmo passar� a ser uma mensagem padr�o, poder�amos model�-la da seguinte forma apresentada no C�digo 3.


class Medicamento(val formula: String, posologia: String, val contraindicacao: String) {

     constructor(formula: String, posologia: String): this(formula, posologia, 
          "Este medicamento n�o � indicado para pessoas al�rgicas a $formula")
}

C�digo 3. Valores padr�o do construtor delegado

Dessa forma, na delegaç�o do construtor this(formula, posologia, "Este medicamento n�o � indicado para pessoas al�rgicas a $formula") informamos um valor padr�o para a propriedade contraindicacao e assim a classe poder� ser instanciada com ou sem esse terceiro par�metro, como mostra o C�digo 4.


val medicamento1 = Medicamento("C8H9NO2", "...")
val medicamento2 = Medicamento("C8H9NO2", "...", "Minha contraindicaç�o")

C�digo 4. Instanciando uma classe com ou sem par�metros

No exemplo acima, o objeto medicamento1 ser� iniciado com o valor padr�o para a propriedade contraindicacao, que � "Este medicamento n�o � indicado para pessoas al�rgicas a $formula". Para o objeto medicamento2, o valor da propriedade contraindicacao ser� aquele informado no construtor, que � "Minha contraindicaç�o".

Construtores e propriedades

O construtor prim�rio age de forma diferente do construtor secund�rio quanto a geraç�o de propriedades para a classe na qual eles s�o declarados. Essa abordagem impede que as propriedades de uma classe variem de acordo com os par�metros declarados nos construtores, uma vez que a geraç�o de propriedades � limitada ao construtor prim�rio de uma classe.

Para demonstrar isso observe a declaraç�o da classe Medicamento no C�digo 5.


class Medicamento {
    constructor(formula: String, posologia: String)
}

C�digo 5.Impedindo as propriedades de variarem

Diferentemente do construtor prim�rio, os par�metros do construtor secund�rio n�o gerar�o propriedades, visto que ao tentar executar um c�digo como o C�digo 6, ser� gerado um erro de compilaç�o.


val medicamento: Medicamento = Medicamento("", "")
medicamento.formula

Error:(10, 17) Kotlin: Unresolved reference: formula

C�digo 6. Erro de compilaç�o

Sendo assim, nesse caso � obrigat�rio declarar uma propriedade na classe Medicamento, a qual poder� receber o valor do par�metro do construtor e ser acessada a partir de uma inst�ncia, como visto acima.

Podemos eliminar o erro ao acessar a propriedade formula, conforme o C�digo 7.


class Medicamento {
     val formula: String

     constructor(formula: String, posologia: String) {
        this.formula = formula
     }
}

C�digo 7. Eliminando o erro de compilaç�o

Assim, uma classe em Kotlin pode possuir propriedades declaradas em seu corpo explicitamente. Essas propriedades podem ser mut�veis, quando declaradas com a palavra reservada var, ou somente leitura, quando declaradas com a palavra reservada val. Caso elas sejam declaradas imut�veis, ser� necess�rio inicializ�-las, o que pode ser feito no construtor secund�rio da classe, como no exemplo acima.

Imutabilidade dos par�metros dos construtores secund�rios

Conforme demonstrado anteriormente, os par�metros do construtor secund�rio s�o declarados sem utilizar as palavras reservadas val ou var, como apresentado no C�digo 8.


class Medicamento {
    constructor(formula: String, posologia: String)
}

C�digo 8. Imutabilidade dos par�metros

Caso uma tentativa de fazer o contr�rio seja feita, digamos declarando a f�rmula como val formula: String, um erro de compilaç�o ser� emitido com a seguinte mensagem apresentada no C�digo 9.


Kotlin: 'val' on secondary constructor parameter is not allowed

C�digo 9. Erro de Compilaç�o

Em Kotlin, tanto os par�metros de funç�es quanto os de construtores s�o imut�veis por definiç�o, o que elimina a necessidade de se utilizar val ou var nesse caso.

Em adendo, a utilizaç�o de val ou var em construtores � restrita ao construtor prim�rio de uma classe para definir a mutabilidade das suas propriedades, ser� imut�vel ou n�o, dado que apenas ele pode gerar propriedades para uma classe.

Por exemplo, digamos que a f�rmula de um medicamento nunca possa alterada, uma vez que seja definida no momento da criaç�o de uma inst�ncia, mas que a sua posologia depende de uma regra externa a essa classe. Dessa forma, podemos modelar a classe Medicamento conforme apresentado a seguir:


class Medicamento(val formula: String, var posologia: String)

Tendo sido o par�metro formula declarado imut�vel, a propriedade hom�nima da classe Medicamento tamb�m ser� somente leitura. Ao tentar atribuir valor a ela a partir de uma inst�ncia o seguinte erro ser� apresentado:


Error:(8, 5) Kotlin: Val cannot be reassigned

O mesmo erro n�o ocorrer� ao atribuir valor a propriedade posologia a partir de uma inst�ncia da classe Medicamento, uma vez que o par�metro posologia, presente no construtor prim�rio, foi declarado mut�vel.

Instanciando uma classe

Para criar uma inst�ncia de uma classe usamos seu nome e construtor. Em Koltin n�o utilizamos a palavra-chave new, como mostra o C�digo 10.


class Medicamento(val formula: String, val posologia: String) {
}

val medicamento = Medicamento("C8H9NO2", "...")

C�digo 10. Sem o uso do new

Aqui devemos observar que se uma classe possui um construtor, sendo ele prim�rio ou secund�rio, o mesmo deve ser invocado. Por exemplo, no C�digo 11 a classe Medicamento possui um construtor secund�rio, o que torna obrigat�rio instanci�-la da forma Medicamento("C8H9NO2", "...").


class Medicamento {
    constructor(formula: String, posologia: String)
}

C�digo 11. Invocando construtor

Caso isso n�o seja feito e a classe seja instanciada como Medicamento(), sem que os argumentos sejam fornecidos para o construtor, teremos um erro de compilaç�o com a mensagem Error:(10, 35) Kotlin: No value passed for parameter 'formula' Error:(10, 35) Kotlin: No value passed for parameter 'posologia', onde formula e posologia s�o propriedades da classe.

Funç�es membro

Funç�es membro s�o funç�es declaradas dentro de classes. As regras que aprendemos anteriormente para a escrita de funç�es tamb�m se aplicam aqui com uma exceç�o, funç�es membro podem utilizar a palavra-chave this para referenciar a inst�ncia atual.

Funç�es membro sempre devem ser invocadas a partir de inst�ncias da classe. No C�digo 12 vemos um exemplo onde invocamos uma funç�o a partir de uma inst�ncia de uma classe Medicamento.


class Medicamento(val formula: String, val posologia: String) {

    fun contem(formula: String) = this.formula.contains(formula, ignoreCase = true)
}

fun main() {
    val medicamento = Medicamento("C8H9NO2", "...")

    if (medicamento.contem("C8H9NO2")) {
        println("Este medicamento cont�m paracetamol")
    }
}

C�digo 12. Funç�es membro

Observe que na Linha 3 utilizamos this para diferenciar entre a propriedade e o par�metro formula.

Tenha cuidado ao usar this em classes que possuam apenas um construtores secund�rios, uma vez que eles n�o geram propriedades e, portanto, devem iniciar a classe ou delegar isso para um outro construtor. Entendido isso, caso uma classe possua apenas um construtor secund�rio ela deve conter propriedades que precisam ser iniciadas dentro dele.

Por exemplo, o C�digo 13 vai falhar ao usarmos a palavra-chave this, pois a classe n�o possui uma propriedade chamada formula.


class Medicamento {
    constructor(formula: String, posologia: String)

    fun contem(formula: String) = this.formula.contains(formula, ignoreCase = true)
}

C�digo 13. Falha ao usar a palavra-chave this

No C�digo 13 o erro emitido pelo compilador ser� Error:(6, 40) Kotlin: Unresolved reference: formula. Para corrigir esse erro a classe precisa iniciar uma propriedade chamada formula no construtor secund�rio, como mostra o C�digo 14.


class Medicamento {
    val formula: String
    val posologia: String

    constructor(formula: String, posologia: String) {
        this.formula = formula
        this.posologia = posologia
    }

    fun contem(formula: String) = this.formula.contains(formula, ignoreCase = true)
}

C�digo 14. Iniciando propriedade

Contudo, o c�digo acima � desnecessariamente longo e nesses casos podemos declarar a classe com um construtor prim�rio, como vemos no C�digo 15.


class Medicamento(val formula: String, val posologia: String) {

    fun contem(formula: String) = this.formula.contains(formula, ignoreCase = true)
}

C�digo 15. Declara a classe com um construtor prim�rio

Sendo assim, o c�digo acima � equivalente ao anterior e tamb�m resolve o problema do this, por�m de um jeito mais sucinto.

Construtores e blocos de inicializaç�o

A delegaç�o de um construtor secund�rio para o construtor prim�rio ocorrer� como sendo a primeira instruç�o no construtor secund�rio. Isso quer dizer que, uma vez que eles passam a fazer parte do construtor prim�rio, cada bloco de inicializaç�o ser� executado antes de qualquer construtor secund�rio.

Fundamentalmente, caso uma classe n�o possua nenhum construtor e n�o seja abstrata, um construtor p�blico vazio lhe ser� atribu�do. Supondo que nessa mesma classe n�o exista um construtor prim�rio declarado, a delegaç�o ocorrer� de forma impl�cita, como demonstrado no C�digo 16.


class Medicamento {
     val formula: String

     constructor(formula: String, posologia: String) {
         this.formula = formula

         println("Construtor secund�rio")
     }

     init {
         println("Bloco de inicializaç�o")
     }
}

C�digo 16. Delegaç�o impl�cita

No exemplo acima, n�o importando a ordem da declaraç�o do construtor secund�rio e do bloco de inicializaç�o, as mensagens exibidas ser�o �Bloco de inicializaç�o� e �Construtor secund�rio�, nessa ordem.

N�veis de acesso

Em Kotlin, n�o informar um n�vel de acesso para um tipo faz com que o modificador public seja automaticamente aplicado. Al�m desse, geralmente n�o utilizado devido a redund�ncia que causa, Kotlin possui tr�s n�veis de acesso. Dentre eles, Protected pode ser utilizado apenas por classes aninhadas. Quando utilizado em n�vel de arquivo, um erro ser� emitido pelo compilador, como mostra o C�digo 17.


protected class Medicamento constructor(val formula: String, var posologia: String)

Error:(3, 1) Kotlin: Modifier 'protected' is not applicable inside 'file'

C�digo 17. Erro do compilador

No C�digo 18 utilizamos o modificador protected, que � sintaticamente permitido porque Tributacao n�o est� em n�vel de arquivo e � uma classe aninhada em Medicamento.


class Medicamento {

    protected class Tributacao
}

C�digo 18. Modificador protected

Private � um n�vel de acesso que restringe o escopo de utilizaç�o da classe apenas ao arquivo no qual ela foi declarada.

Ao tentar utilizar uma classe private fora do arquivo no qual ela foi declarada, um erro ser� emitido pelo compilador prematuramente, no momento da sua importaç�o, como mostra o C�digo 19.


private class Medicamento constructor(val formula: String, var posologia: String)

import br.com.devmedia.kotlin.a.Medicamento

fun main(args: Array) {
     println(Medicamento("C8H9NO2", "...12 anos ou mais variam de 500 a 1000 mg/
     dose com intervalos de 4 a 6 horas..."))
}

Error:(3, 33) Kotlin: Cannot access 'Medicamento': it is private in file

C�digo 19. Modificador private

Em Kotlin, a declaraç�o de um pacote � feita com a palavra reservada package, seguida do nome do pacote. A importaç�o de uma classe de outro pacote � feita com a palavra import, seguida do nome completo da classe.

O terceiro modificador de acesso � internal, que permite criar uma inst�ncia da classe em qualquer lugar no m�dulo no qual ela foi declarado. Para o Kotlin um m�dulo � um conjunto de fontes compilados juntos. Isso torna esse comportamento dif�cil de ser verificado em um mesmo m�dulo do Intellij IDEA, projeto do Maven, Ant task, etc.

Conclus�o

Kotlin � uma linguagem orientada a objetos e funcional, que ganhou maior popularidade ao ser anunciada como uma alternativa ao Java para desenvolvimento para Android, na I/O Conference de 2017. Desde ent�o, diversos projetos como Kotlin Native, Coroutines e Kotlin to JavaScript t�m sido alvo do interesse de diferentes comunidades de programadores. Independe de qual seja o prop�sito para o qual voc� pretende utilizar o Kotlin, ser� necess�rio conhecer a sintaxe dessa linguagem, que � concisa e, ao mesmo tempo, repleta de recursos sint�ticos.

Confira tamb�m

Aprender Java

S�rie

Cursos de Mobile

Curso

Android Developer

S�rie

Kotlin: Classes

Ao concluir esse artigo você saberá como utilizar classes em Kotlin, evitando assim as armadilhas sintáticas dessa linguagem ao usar construtores e blocos de inicialização.

Kotlin: Classes

Artigos da S�rie Kotlin

Declaraç�o de classes

Construtores

Construtores e propriedades

Imutabilidade dos par�metros dos construtores secund�rios

Instanciando uma classe

Funç�es membro

Construtores e blocos de inicializaç�o

N�veis de acesso

Conclus�o

Confira tamb�m

Aprender Java

Cursos de Mobile

Android Developer

Artigos relacionados