Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Java

Cópia defensiva de coleções

Copia a lista no construtor e em `getRoles()` para impedir que o código chamador altere a lista guardada no DTO. A palavra-chave `final`, por si só, não chega.

Versão: Java SE 21

Sintaxe

private final List<String> roles;

RolesDto(List<String> roles) {
    this.roles = new ArrayList<>(roles);
}

public List<String> getRoles() {
    return new ArrayList<>(roles);
}

A cópia defensiva de coleções protege o estado de um objeto contra alterações através de uma referência partilhada. Num objeto de transferência de dados (DTO), o construtor guarda new ArrayList<>(roles) em vez de conservar a lista recebida. Cada chamada a getRoles() devolve uma nova lista modificável. Ambas as cópias preservam a ordem dos elementos. final impede a atribuição de outra lista ao campo, mas não impede operações como add ou set sobre a própria lista.

new ArrayList<>(roles) cria uma cópia superficial: as listas são objetos distintos, mas referenciam os mesmos elementos. Isto basta para String, porque as cadeias de caracteres são imutáveis. Se os elementos forem mutáveis, uma alteração do seu estado pode ser visível através de ambas as listas. Se também precisares de isolar esse estado, copia-o à entrada e à saída ou usa tipos de elementos imutáveis.

Se o código chamador não precisar de editar o resultado e null não for permitido, guarda List.copyOf(roles) no construtor e devolve essa lista diretamente. Alterações posteriores à lista de origem não se refletem no resultado, e copyOf não tem de criar uma nova instância. Os métodos de modificação do resultado lançam UnsupportedOperationException; uma origem ou um elemento null provoca NullPointerException. O resultado continua a ser superficial. Já Collections.unmodifiableList(roles) cria uma vista não modificável, não uma cópia: as alterações à lista de origem continuam visíveis nessa vista.

Exemplos

import java.util.ArrayList;
import java.util.List;

public class Main {
    static final class RolesDto {
        private final List<String> roles;

        RolesDto(List<String> roles) {
            this.roles = new ArrayList<>(roles);
        }

        public List<String> getRoles() {
            return new ArrayList<>(roles);
        }
    }

    public static void main(String[] args) {
        List<String> input = new ArrayList<>(List.of("reader"));
        RolesDto dto = new RolesDto(input);
        input.add("admin");

        List<String> returned = dto.getRoles();
        returned.set(0, "owner");

        System.out.println(input);
        System.out.println(returned);
        System.out.println(dto.getRoles());
    }
}

Resultado

[reader, admin]
[owner]
[reader]

`input.add("admin")` altera apenas a lista de entrada e `returned.set(0, "owner")` altera apenas a cópia da primeira chamada a `getRoles()`. A segunda chamada continua a devolver `[reader]`.

Lições relacionadas

  • Java · Lição 10 · Avançado · Versão: 2

Fontes