Генерация сеттеров и геттеров с использованием Java :: Geci

В этой  статье мы создали очень простые генераторы hello-world, чтобы представить среду и способы генерации генераторов в целом. В этой статье мы рассмотрим генератор аксессоров, который определен в базовом модуле Java :: Geci и является коммерческим, а не демо-генератором. Несмотря на то, что генератор — это коммерческий класс, использующий сервисы фреймворка, он имеет простой код, чтобы его можно было представить в статье.

Что такое генератор доступа?

Аксессорами являются сеттеры и геттеры. Когда у класса много полей, и мы хотим помочь инкапсуляции, мы объявляем эти поля privateравными и создаем установщики и получатели, пару для каждого поля, которая может установить значение для поля (установщик) и может получить значение поля (добытчик). Обратите внимание, что вопреки тому, что думают многие юниоры, создание сеттеров и геттеров само по себе не является инкапсуляцией, но может быть инструментом для правильной инкапсуляции. И в то же время, обратите внимание, что он также не может быть инструментом для правильной инкапсуляции. Вы можете прочитать больше об этом в « Эффективной Java Джошуа Блоха : 3-е издание»,  пункт 16.

Прочитайте это с некоторой осторожностью, все же. В книге говорится, что она была обновлена ​​для Java 9. Эта версия Java содержит систему модулей. В пункте 16 главы это не упоминается, и даже в этом издании все еще говорится об использовании закрытых членов с установщиками и получателями для открытых классов, что в случае Java 9 также может означать классы в пакетах, которые модуль не экспортирует.

Многие разработчики утверждают, что сеттеры и геттеры изначально являются злом и признаком плохого дизайна. Не ошибись! Они не выступают за непосредственное использование необработанных полей. Это было бы еще хуже. Они утверждают, что вы должны программировать с более объектно-ориентированным мышлением. На мой взгляд, они правы, и все же в моей профессиональной практике мне приходится использовать множество классов, поддерживающих унаследованные приложения, использующие устаревшие фреймворки, которые содержат сеттеры и геттеры, которые необходимы инструментам программирования вокруг приложения. Теория это одно; реальная жизнь это другое. Различные интегрированные среды разработки и многие другие инструменты генерируют для нас сеттеры и геттеры, если только мы не забудем выполнить их при добавлении нового поля.

Сеттер — это метод, который имеет аргумент того же типа, что и поле, и возвращает void. (Aka не возвращает никакого значения.) Имя установщика, по соглашению, — это setи имя поля с заглавной первой буквой. Для поля businessOwnerсеттер обычно setBusinessOwner. Сеттер устанавливает значение поля равным аргументу сеттера.

Получатель также является методом, который не имеет никакого аргумента, но возвращает значение аргумента, и, следовательно, он имеет тот же тип возврата, что и тип поля. Имя получателя, по соглашению, является get, и снова, имя поля пишется с большой буквы. Таким образом, получатель будет getBusinessOwner.

В случае полей типа booleanили Boolean, получатель может иметь isпрефикс, поэтому isBusinessOwnerтакже может быть допустимым именем в случае, если поле имеет некоторый логический тип.

Аксессор генерирует сеттер и геттер для всех необходимых ему полей.

Как создать аксессоры

Генератор доступа должен генерировать код для некоторых полей класса. Этот генератор является идеальным кандидатом для генератора фильтрованного поля в Java :: Geci. Генератор отфильтрованного поля расширяет AbstractFilteredFieldsGeneratorкласс, и его process()метод вызывается один раз для каждого отфильтрованного поля. Этот метод также получает в Fieldкачестве третьего параметра в дополнение к обычному параметру Sourceи CompoundParamsпараметру, которые мы уже видели в статье несколько недель назад .

Класс AbstractFilteredFieldsGeneratorиспользует параметр конфигурации filterдля фильтрации полей. Таким образом, выбор того поля, которое необходимо учитывать, одинаков для каждого генератора, расширяющего этот класс, и генераторы не должны заботиться о фильтрации полей: это делается для них.

Основная часть кода генератора следующая:

public class Accessor extends AbstractFilteredFieldsGenerator {

    ...

    @Override
    public void process(Source source, Class<?> klass, 
                        CompoundParams params, 
                        Field field) throws Exception {
        final var id = params.get("id");
        source.init(id);
        var isFinal = Modifier.isFinal(field.getModifiers());
        var name = field.getName();
        var fieldType = GeciReflectionTools.typeAsString(field);
        var access = check(params.get("access", "public"));
        var ucName = cap(name);
        var setter = params.get("setter", "set" + ucName);
        var getter = params.get("getter", "get" + ucName);
        var only = params.get("only");
        try (var segment = source.safeOpen(id)) {
            if (!isFinal && !"getter".equals(only)) {
                writeSetter(name, setter, fieldType, access, segment);
            }
            if (!"setter".equals(only)) {
                writeGetter(name, getter, fieldType, access, segment);
            }
        }
    }
}

private static void writeGetter(String name, String getterName,
                                String type, String access, Segment segment) {
    segment.write_r(access + " " + type + " " + getterName + "(){")
            .write("return " + name + ";")
            .write_l("}")
            .newline();
}

private static void writeSetter(String name, String setterName,
                                String type, String access, Segment segment) {
    segment.write_r(access + " void " + setterName + "(" +
            type + " " + name + "){")
            .write("this." + name + " = " + name + ";")
            .write_l("}")
            .newline();
}

private static final Set<String> accessModifiers =
            Set.of("public", "private", "protected", "package");
...

    private String check(final String access) {
        if (!access.endsWith("!") && !accessModifiers.contains(access)) {
            throw new GeciException("'"+access+"' is not a valid access modifier");
        }
        final String modifiedAccess;
        if( access.endsWith("!")){
            modifiedAccess = access.substring(0,access.length()-1);
        }else {
            modifiedAccess = access;
        }
        if( modifiedAccess.equals("package")){
            return "";
        }
        return modifiedAccess;
    }

private static String cap(String s) {
    return s.substring(0, 1).toUpperCase() + s.substring(1);
}

@Override
public String mnemonic() {
    return "accessor";
}

@Geci("accessor filter='private | protected'")
public class Contained1 {

    public void callMe() {

    }

    private final String apple = "";
    @Geci("accessors only='setter'")
    private int birnen;

    int packge;

    @Geci("accessor access='package' getter='isTrue'")
    protected boolean truth;
    @Geci("accessor filter='false'")
    protected int not_this;

    public Map<String,Set<Map<Integer,Boolean>>> doNothingReally(int a, Map b, Set<Set> set){
        return null;
    }

    //<editor-fold id="accessor" desc="setters">

    //</editor-fold>

}

//<editor-fold id="accessor" desc="setters">

//</editor-fold>