10 лучших советов и приемов, связанных с Quarkus Framework

В этой статье вы узнаете несколько полезных советов и приемов, связанных с фреймворком Quarkus. Мы сосредоточимся на функциях, которые отличают Quarkus от других фреймворков.

Если вы запускаете свои приложения в Kubernetes, Quarkus, очевидно, является хорошим выбором. Запускается быстро и не потребляет много памяти. Вы можете легко скомпилировать его с помощью GraalVM. Он предоставляет множество полезных функций для разработчиков, таких как, например, горячая перезагрузка. Надеюсь, вы найдете там советы и приемы, которые помогут повысить вашу продуктивность при разработке Quarkus. Или, может быть, просто убедить вас взглянуть на это, если у вас еще нет опыта.

Оглавление

  • Совет 1. Используйте инструмент командной строки Quarkus
  • Совет 2. Используйте Dev Services с базами данных
  • Совет 3. Используйте упрощенный ORM с Panache
  • Совет 4. Унифицированная конфигурация как вариант
  • Совет 5. Разверните в Kubernetes с помощью Maven
  • Совет 6. Получите доступ к консоли Dev UI
  • Совет 7. Постоянно тестируйте
  • Совет 8. Скомпилируйте с помощью GraalVM на OpenShift
  • Совет 9. Откатывайте транзакцию после каждого теста
  • Совет 10. Воспользуйтесь преимуществами поддержки GraphQL
  • Заключительные мысли

Совет 1. Используйте инструмент командной строки Quarkus

Как запустить новое приложение при использовании одной из популярных сред Java? Вы можете перейти на веб-сайт онлайн-генератора, который обычно предоставляется этими фреймворками. Вы слышали о Spring Initializr? Quarkus предлагает аналогичный сайт по адресу https://code.quarkus.io/ . Но что вы, возможно, не знаете, так это инструмент командной строки Quarkus. Он позволяет создавать проекты, управлять расширениями и выполнять команды сборки и разработки. Например, вы можете создать исходный код для нового приложения с помощью одной команды, как показано ниже.

$ quarkus create app --package-name=pl.piomin.samples.quarkus \
  -x resteasy-jackson,hibernate-orm-panache,jdbc-postgresql \
  -o person-service \
  pl.piomin.samples:person-service

После выполнения команды, показанной выше, вы должны увидеть аналогичный экран.

quarkus-советы-кли

Эта команда создает простое приложение REST, использующее базу данных PostgreSQL и уровень ORM Quarkus. Кроме того, он устанавливает имя приложения, Maven groupIdи artifactId. После этого вы можете просто запустить приложение. Для этого перейдите в сгенерированный каталог и выполните следующую команду. Кроме того, вы можете выполнить mvn quarkus:devкоманду.

$ quarkus dev

Приложение не запускается успешно, так как не настроено подключение к базе данных. Должны ли мы это делать? Нет! Давайте перейдем к следующему разделу, чтобы понять, почему.

Совет 2. Используйте Dev Services с базами данных

Вы слышали о тестовых контейнерах? Это библиотека Java, которая позволяет автоматически запускать контейнеры во время тестов JUnit. Вы можете запускать обычные базы данных, веб-браузеры Selenium или что-то еще, что может работать в контейнере Docker. Quarkus обеспечивает встроенную интеграцию с тестовыми контейнерами при запуске приложений в режимах разработки или тестирования. Эта функция называется Dev Services. Более того, вам не нужно ничего делать, чтобы включить его. Просто НЕ ПРЕДОСТАВЛЯЙТЕ URL-адрес подключения и учетные данные.

Вернемся к нашему сценарию. Мы уже создали приложение с помощью Quarkus CLI. Он содержит все необходимые библиотеки. Итак, единственное, что нам нужно сделать сейчас, это запустить демон Docker. Благодаря этому Quarkus попытается запустить PostgreSQL с тестовыми контейнерами в режиме разработки. Каков конечный результат? Наше приложение работает и связано с PostgreSQL, запущенным с помощью Docker, как показано ниже.

Тогда можно переходить к разработке. С помощью quarkus devкоманды мы уже включили режим разработки. Благодаря этому мы можем воспользоваться функцией перезагрузки в реальном времени.

Совет 3. Используйте упрощенный ORM с Panache

Давайте добавим немного кода в наше примерное приложение. Мы реализуем уровень данных с помощью Quarkus Panache ORM. Это очень интересный модуль, который фокусируется на том, чтобы сделать ваши сущности тривиальными и увлекательными для написания в Quarkus. Вот наш класс сущности. Благодаря перезаписи доступа к полю Quarkus, когда вы читаете  person.name , вы фактически вызываете свой  метод доступа getName() , и аналогично для записи в поле и сеттера. Это обеспечивает правильную инкапсуляцию во время выполнения, поскольку все вызовы полей будут заменены соответствующими вызовами геттера или сеттера. Также PanacheEntityпозаботится о реализации первичного ключа.

@Entity
public class Person extends PanacheEntity {
   public String name;
   public int age;
   @Enumerated(EnumType.STRING)
   public Gender gender;
}

На следующем шаге мы собираемся определить класс репозитория. Поскольку он реализует PanacheRepositoryинтерфейс, нам нужно только добавить наши собственные методы поиска.

@ApplicationScoped
public class PersonRepository implements PanacheRepository<Person> {

    public List<Person> findByName(String name) {
        return find("name", name).list();
    }

    public List<Person> findByAgeGreaterThan(int age) {
        return find("age > ?1", age).list();
    }
}

Наконец, давайте добавим класс ресурсов с конечными точками REST.

@Path("/persons")
public class PersonResource {

    @Inject
    PersonRepository personRepository;

    @POST
    @Transactional
    public Person addPerson(Person person) {
        personRepository.persist(person);
        return person;
    }

    @GET
    public List<Person> getPersons() {
        return personRepository.listAll();
    }

    @GET
    @Path("/name/{name}")
    public List<Person> getPersonsByName(@PathParam("name") String name) {
        return personRepository.findByName(name);
    }

    @GET
    @Path("/age-greater-than/{age}")
    public List<Person> getPersonsByName(@PathParam("age") int age) {
        return personRepository.findByAgeGreaterThan(age);
    }

    @GET
    @Path("/{id}")
    public Person getPersonById(@PathParam("id") Long id) {
        return personRepository.findById(id);
    }

}

Кроме того, давайте создадим import.sqlфайл в src/main/resourcesкаталоге. Он загружает операторы SQL при запуске Hibernate ORM.

insert into person(id, name, age, gender) values(1, 'John Smith', 25, 'MALE');
insert into person(id, name, age, gender) values(2, 'Paul Walker', 65, 'MALE');
insert into person(id, name, age, gender) values(3, 'Lewis Hamilton', 35, 'MALE');
insert into person(id, name, age, gender) values(4, 'Veronica Jones', 20, 'FEMALE');
insert into person(id, name, age, gender) values(5, 'Anne Brown', 60, 'FEMALE');
insert into person(id, name, age, gender) values(6, 'Felicia Scott', 45, 'FEMALE');

Наконец, мы можем вызвать нашу конечную точку REST.

$ curl http://localhost:8080/persons

 

Совет 4. Унифицированная конфигурация как вариант

Предполагая, что мы не хотим запускать базу данных в Docker, мы должны настроить соединение в application.properties. По умолчанию Quarkus предоставляет 3 профиля: prod, test, dev. Мы можем определить свойства для нескольких профилей внутри одного, application.propertiesиспользуя синтаксис  %{profile-name}.config.name. В нашем случае есть экземпляр H2, используемый в режимах devи test, и внешний экземпляр PostgreSQL в prodрежиме.

quarkus.datasource.db-kind=postgresql
quarkus.datasource.username=${POSTGRES_USER}
quarkus.datasource.password=${POSTGRES_PASSWORD}
quarkus.datasource.jdbc.url=jdbc:postgresql://person-db:5432/${POSTGRES_DB}

%test.quarkus.datasource.db-kind=h2
%test.quarkus.datasource.username=sa
%test.quarkus.datasource.password=password
%test.quarkus.datasource.jdbc.url=jdbc:h2:mem:testdb

%dev.quarkus.datasource.db-kind=h2
%dev.quarkus.datasource.username=sa
%dev.quarkus.datasource.password=password
%dev.quarkus.datasource.jdbc.url=jdbc:h2:mem:testdb

Перед запуском новой версии приложения мы должны включить зависимость H2 в Maven pom.xml.

<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-jdbc-h2</artifactId>
</dependency>

Вы также можете определить свой собственный профиль и указать свойства, используя его в качестве префикса. Конечно, вы по-прежнему можете определять файлы для конкретных профилей, такие как application-{profile}.properties.

Совет 5. Разверните в Kubernetes с помощью Maven

Quarkus в нативной среде Kubernetes. Вы можете легко развернуть приложение Quarkus в кластере Kubernetes без создания файлов YAML вручную. Для более сложных конфигураций, таких как, например, сопоставление секретов с переменными среды, вы можете использовать application.properties. Другие вещи, такие как, например, проверки работоспособности, обнаруживаются в исходном коде. Для этого нам нужно подключить quarkus-kubernetesмодуль. Также есть реализация для OpenShift.

<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-openshift</artifactId>
</dependency>

После этого Quarkus создаст манифесты развертывания во время сборки Maven. Мы можем включить автоматическое развертывание в текущем кластере Kubernetes, установив для свойства quarkus.kubernetes.deployзначение true. Для развертывания OpenShift мы должны изменить цель развертывания по умолчанию с kubernetesна openshift.

quarkus.container-image.build = true
quarkus.kubernetes.deploy = true
quarkus.kubernetes.deployment-target = openshift

Предположим, у нас есть некоторая пользовательская конфигурация для установки в Deploymentманифесте. Наше приложение будет работать в двух модулях и автоматически будет отображаться за пределами кластера. Он также вводит значения Secretдля подключения к базе данных PostgreSQL.

quarkus.openshift.expose = true
quarkus.openshift.replicas = 2
quarkus.openshift.labels.app = person-app
quarkus.openshift.annotations.app-type = demo
quarkus.openshift.env.mapping.postgres_user.from-secret = person-db
quarkus.openshift.env.mapping.postgres_user.with-key = database-user
quarkus.openshift.env.mapping.postgres_password.from-secret = person-db
quarkus.openshift.env.mapping.postgres_password.with-key = database-password
quarkus.openshift.env.mapping.postgres_db.from-secret = person-db
quarkus.openshift.env.mapping.postgres_db.with-key = database-name

Затем нам просто нужно собрать наше приложение с помощью Maven. В качестве альтернативы мы можем удалить это quarkus.kubernetes.deployсвойство application.propertiesи включить его в команде Maven.

$ maven clean package -D<meta charset="utf-8">quarkus.kubernetes.deploy=true

 

Совет 6. Получите доступ к консоли Dev UI

После запуска приложения Quarkus в режиме разработки ( mvn<em> </em>quarkus:dev) вы можете получить доступ к консоли Dev UI по адресу http://localhost:8080/q/dev . Чем больше модулей вы включаете, тем больше параметров вы можете там настроить. Одна из моих любимых функций здесь — возможность развертывания приложений в OpenShift. Вместо запуска команды Maven для создания приложения мы можем просто запустить его в devрежиме и развернуть с помощью графического интерфейса.

quarkus-советы-dev-ui

 

Совет 7. Постоянно тестируйте

Quarkus поддерживает непрерывное тестирование, когда тесты запускаются сразу после изменения кода. Это позволяет вам мгновенно получать отзывы об изменениях кода. Quarkus определяет, какие тесты покрывают какой код, и использует эту информацию для запуска соответствующих тестов только при изменении кода. После запуска приложения в разработке вам будет предложено включить эту функцию, как показано ниже. Просто нажмите r, чтобы включить его.

Итак, давайте добавим несколько тестов для нашего примера приложения. Во-первых, нам нужно включить тестовый модуль Quarkus и библиотеку REST Assured.

<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-junit5</artifactId>
   <scope>test</scope>
</dependency>
<dependency>
   <groupId>io.rest-assured</groupId>
   <artifactId>rest-assured</artifactId>
   <scope>test</scope>
</dependency>

Затем мы добавим несколько простых тестов API. Тестовый класс должен быть аннотирован с помощью @QuarkusTest. В остальном реализация типична для библиотеки REST Assured.

@QuarkusTest
public class PersonResourceTests {

    @Test
    void getPersons() {
        List<Person> persons = given().when().get("/persons")
                .then()
                .statusCode(200)
                .extract()
                .body()
                .jsonPath().getList(".", Person.class);
        assertEquals(persons.size(), 6);
    }

    @Test
    void getPersonById() {
        Person person = given()
                .pathParam("id", 1)
                .when().get("/persons/{id}")
                .then()
                .statusCode(200)
                .extract()
                .body().as(Person.class);
        assertNotNull(person);
        assertEquals(1L, person.id);
    }

    @Test
    void newPersonAdd() {
        Person newPerson = new Person();
        newPerson.age = 22;
        newPerson.name = "TestNew";
        newPerson.gender = Gender.FEMALE;
        Person person = given()
                .body(newPerson)
                .contentType(ContentType.JSON)
                .when().post("/persons")
                .then()
                .statusCode(200)
                .extract()
                .body().as(Person.class);
        assertNotNull(person);
        assertNotNull(person.id);
    }
}

Мы также можем запускать эти тесты JUnit из консоли Dev UI. Во-первых, вы должны перейти в консоль Dev UI. Внизу страницы вы найдете модуль ответственного тестирования панели. Просто щелкните значок Результат теста , и вы увидите экран, подобный показанному ниже.

 

Совет 8. Скомпилируйте с помощью GraalVM на OpenShift

Вы можете легко создать и запустить собственный образ Quarkus GraalVM в OpenShift с помощью одной команды и сборщика ubi-quarkus-native-s2i. OpenShift создает приложение, используя подход S2I (исходный код 2 образа). Конечно, вам просто нужен работающий кластер OpenShift (например, локальный CRC или тестовая среда разработчика https://developers.redhat.com/products/codeready-containers/overview ) и ocклиент, установленный локально.

$ oc new-app --name person-native \
             --context-dir basic-with-db/person-app \
  quay.io/quarkus/ubi-quarkus-native-s2i:21.2-java11~https://github.com/piomin/openshift-quickstart.git

Совет 9. Откатывайте транзакцию после каждого теста

Если вам нужно откатить изменения в данных после каждого теста, не делайте этого вручную. Вместо этого вам просто нужно аннотировать свой тестовый класс с помощью @TestTransaction. Откат выполняется каждый раз, когда метод тестирования завершается.

@QuarkusTest
@TestTransaction
public class PersonRepositoryTests {

    @Inject
    PersonRepository personRepository;

    @Test
    void addPerson() {
        Person newPerson = new Person();
        newPerson.age = 22;
        newPerson.name = "TestNew";
        newPerson.gender = Gender.FEMALE;
        personRepository.persist(newPerson);
        Assertions.assertNotNull(newPerson.id);
    }
}

 

Совет 10. Воспользуйтесь преимуществами поддержки GraphQL

Это последний совет Quarkus в этой статье. Тем не менее, это одна из моих любимых функций Quarkus. Поддержка GraphQL не является сильной стороной Spring Boot. С другой стороны, Quarkus предоставляет очень классные и простые расширения для GraphQL для клиента и сервера.

Во-первых, добавим модули Quarkus, отвечающие за поддержку GraphQL.

<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-smallrye-graphql</artifactId>
</dependency>
<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-smallrye-graphql-client</artifactId>
   <scope>test</scope>
</dependency>

Затем мы можем создать код, отвечающий за предоставление GraphQL API. Класс должен быть аннотирован с помощью @GraphQLAPI. Quarkus автоматически генерирует схему GraphQL из исходного кода.

@GraphQLApi
public class EmployeeFetcher {

    private EmployeeRepository repository;

    public EmployeeFetcher(EmployeeRepository repository){
        this.repository = repository;
    }

    @Query("employees")
    public List<Employee> findAll() {
        return repository.listAll();
    }

    @Query("employee")
    public Employee findById(@Name("id") Long id) {
        return repository.findById(id);
    }

    @Query("employeesWithFilter")
    public List<Employee> findWithFilter(@Name("filter") EmployeeFilter filter) {
        return repository.findByCriteria(filter);
    }

}

Затем давайте создадим клиентский интерфейс для вызова двух конечных точек. Нам нужно аннотировать этот интерфейс с помощью @GraphQLClientApi.

@GraphQLClientApi(configKey = "employee-client")
public interface EmployeeClient {

    List<Employee> employees();
    Employee employee(Long id);
}

Наконец, мы можем добавить простой тест JUnit. Нам просто нужно внедрить EmployeeClient, а затем вызвать методы. Если вас интересуют более подробные сведения о поддержке Quarkus GraphQL, прочитайте мою статью An Advanced GraphQL with Quarkus .

@QuarkusTest
public class EmployeeFetcherTests {

    @Inject
    EmployeeClient employeeClient;

    @Test
    void fetchAll() {
        List<Employee> employees = employeeClient.employees();
        Assertions.assertEquals(10, employees.size());
    }

    @Test
    void fetchById() {
        Employee employee = employeeClient.employee(10L);
        Assertions.assertNotNull(employee);
    }
}

Заключительные мысли

На мой взгляд, Quarkus — очень интересный и перспективный фреймворк. С помощью этих советов вы легко сможете начать разработку своего первого приложения с помощью Quarkus. В каждом новом релизе появляются новые интересные функции. Так что, возможно, мне скоро придется обновить этот список советов по Quarkus.

Ссылка: https://piotrminkowski.com/2021/10/12/quarkus-tips-tricks-and-techniques/

#quarkus #java #tips

What is GEEK

Buddha Community

10 лучших советов и приемов, связанных с Quarkus Framework

10 лучших советов и приемов, связанных с Quarkus Framework

В этой статье вы узнаете несколько полезных советов и приемов, связанных с фреймворком Quarkus. Мы сосредоточимся на функциях, которые отличают Quarkus от других фреймворков.

Если вы запускаете свои приложения в Kubernetes, Quarkus, очевидно, является хорошим выбором. Запускается быстро и не потребляет много памяти. Вы можете легко скомпилировать его с помощью GraalVM. Он предоставляет множество полезных функций для разработчиков, таких как, например, горячая перезагрузка. Надеюсь, вы найдете там советы и приемы, которые помогут повысить вашу продуктивность при разработке Quarkus. Или, может быть, просто убедить вас взглянуть на это, если у вас еще нет опыта.

Оглавление

  • Совет 1. Используйте инструмент командной строки Quarkus
  • Совет 2. Используйте Dev Services с базами данных
  • Совет 3. Используйте упрощенный ORM с Panache
  • Совет 4. Унифицированная конфигурация как вариант
  • Совет 5. Разверните в Kubernetes с помощью Maven
  • Совет 6. Получите доступ к консоли Dev UI
  • Совет 7. Постоянно тестируйте
  • Совет 8. Скомпилируйте с помощью GraalVM на OpenShift
  • Совет 9. Откатывайте транзакцию после каждого теста
  • Совет 10. Воспользуйтесь преимуществами поддержки GraphQL
  • Заключительные мысли

Совет 1. Используйте инструмент командной строки Quarkus

Как запустить новое приложение при использовании одной из популярных сред Java? Вы можете перейти на веб-сайт онлайн-генератора, который обычно предоставляется этими фреймворками. Вы слышали о Spring Initializr? Quarkus предлагает аналогичный сайт по адресу https://code.quarkus.io/ . Но что вы, возможно, не знаете, так это инструмент командной строки Quarkus. Он позволяет создавать проекты, управлять расширениями и выполнять команды сборки и разработки. Например, вы можете создать исходный код для нового приложения с помощью одной команды, как показано ниже.

$ quarkus create app --package-name=pl.piomin.samples.quarkus \
  -x resteasy-jackson,hibernate-orm-panache,jdbc-postgresql \
  -o person-service \
  pl.piomin.samples:person-service

После выполнения команды, показанной выше, вы должны увидеть аналогичный экран.

quarkus-советы-кли

Эта команда создает простое приложение REST, использующее базу данных PostgreSQL и уровень ORM Quarkus. Кроме того, он устанавливает имя приложения, Maven groupIdи artifactId. После этого вы можете просто запустить приложение. Для этого перейдите в сгенерированный каталог и выполните следующую команду. Кроме того, вы можете выполнить mvn quarkus:devкоманду.

$ quarkus dev

Приложение не запускается успешно, так как не настроено подключение к базе данных. Должны ли мы это делать? Нет! Давайте перейдем к следующему разделу, чтобы понять, почему.

Совет 2. Используйте Dev Services с базами данных

Вы слышали о тестовых контейнерах? Это библиотека Java, которая позволяет автоматически запускать контейнеры во время тестов JUnit. Вы можете запускать обычные базы данных, веб-браузеры Selenium или что-то еще, что может работать в контейнере Docker. Quarkus обеспечивает встроенную интеграцию с тестовыми контейнерами при запуске приложений в режимах разработки или тестирования. Эта функция называется Dev Services. Более того, вам не нужно ничего делать, чтобы включить его. Просто НЕ ПРЕДОСТАВЛЯЙТЕ URL-адрес подключения и учетные данные.

Вернемся к нашему сценарию. Мы уже создали приложение с помощью Quarkus CLI. Он содержит все необходимые библиотеки. Итак, единственное, что нам нужно сделать сейчас, это запустить демон Docker. Благодаря этому Quarkus попытается запустить PostgreSQL с тестовыми контейнерами в режиме разработки. Каков конечный результат? Наше приложение работает и связано с PostgreSQL, запущенным с помощью Docker, как показано ниже.

Тогда можно переходить к разработке. С помощью quarkus devкоманды мы уже включили режим разработки. Благодаря этому мы можем воспользоваться функцией перезагрузки в реальном времени.

Совет 3. Используйте упрощенный ORM с Panache

Давайте добавим немного кода в наше примерное приложение. Мы реализуем уровень данных с помощью Quarkus Panache ORM. Это очень интересный модуль, который фокусируется на том, чтобы сделать ваши сущности тривиальными и увлекательными для написания в Quarkus. Вот наш класс сущности. Благодаря перезаписи доступа к полю Quarkus, когда вы читаете  person.name , вы фактически вызываете свой  метод доступа getName() , и аналогично для записи в поле и сеттера. Это обеспечивает правильную инкапсуляцию во время выполнения, поскольку все вызовы полей будут заменены соответствующими вызовами геттера или сеттера. Также PanacheEntityпозаботится о реализации первичного ключа.

@Entity
public class Person extends PanacheEntity {
   public String name;
   public int age;
   @Enumerated(EnumType.STRING)
   public Gender gender;
}

На следующем шаге мы собираемся определить класс репозитория. Поскольку он реализует PanacheRepositoryинтерфейс, нам нужно только добавить наши собственные методы поиска.

@ApplicationScoped
public class PersonRepository implements PanacheRepository<Person> {

    public List<Person> findByName(String name) {
        return find("name", name).list();
    }

    public List<Person> findByAgeGreaterThan(int age) {
        return find("age > ?1", age).list();
    }
}

Наконец, давайте добавим класс ресурсов с конечными точками REST.

@Path("/persons")
public class PersonResource {

    @Inject
    PersonRepository personRepository;

    @POST
    @Transactional
    public Person addPerson(Person person) {
        personRepository.persist(person);
        return person;
    }

    @GET
    public List<Person> getPersons() {
        return personRepository.listAll();
    }

    @GET
    @Path("/name/{name}")
    public List<Person> getPersonsByName(@PathParam("name") String name) {
        return personRepository.findByName(name);
    }

    @GET
    @Path("/age-greater-than/{age}")
    public List<Person> getPersonsByName(@PathParam("age") int age) {
        return personRepository.findByAgeGreaterThan(age);
    }

    @GET
    @Path("/{id}")
    public Person getPersonById(@PathParam("id") Long id) {
        return personRepository.findById(id);
    }

}

Кроме того, давайте создадим import.sqlфайл в src/main/resourcesкаталоге. Он загружает операторы SQL при запуске Hibernate ORM.

insert into person(id, name, age, gender) values(1, 'John Smith', 25, 'MALE');
insert into person(id, name, age, gender) values(2, 'Paul Walker', 65, 'MALE');
insert into person(id, name, age, gender) values(3, 'Lewis Hamilton', 35, 'MALE');
insert into person(id, name, age, gender) values(4, 'Veronica Jones', 20, 'FEMALE');
insert into person(id, name, age, gender) values(5, 'Anne Brown', 60, 'FEMALE');
insert into person(id, name, age, gender) values(6, 'Felicia Scott', 45, 'FEMALE');

Наконец, мы можем вызвать нашу конечную точку REST.

$ curl http://localhost:8080/persons

 

Совет 4. Унифицированная конфигурация как вариант

Предполагая, что мы не хотим запускать базу данных в Docker, мы должны настроить соединение в application.properties. По умолчанию Quarkus предоставляет 3 профиля: prod, test, dev. Мы можем определить свойства для нескольких профилей внутри одного, application.propertiesиспользуя синтаксис  %{profile-name}.config.name. В нашем случае есть экземпляр H2, используемый в режимах devи test, и внешний экземпляр PostgreSQL в prodрежиме.

quarkus.datasource.db-kind=postgresql
quarkus.datasource.username=${POSTGRES_USER}
quarkus.datasource.password=${POSTGRES_PASSWORD}
quarkus.datasource.jdbc.url=jdbc:postgresql://person-db:5432/${POSTGRES_DB}

%test.quarkus.datasource.db-kind=h2
%test.quarkus.datasource.username=sa
%test.quarkus.datasource.password=password
%test.quarkus.datasource.jdbc.url=jdbc:h2:mem:testdb

%dev.quarkus.datasource.db-kind=h2
%dev.quarkus.datasource.username=sa
%dev.quarkus.datasource.password=password
%dev.quarkus.datasource.jdbc.url=jdbc:h2:mem:testdb

Перед запуском новой версии приложения мы должны включить зависимость H2 в Maven pom.xml.

<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-jdbc-h2</artifactId>
</dependency>

Вы также можете определить свой собственный профиль и указать свойства, используя его в качестве префикса. Конечно, вы по-прежнему можете определять файлы для конкретных профилей, такие как application-{profile}.properties.

Совет 5. Разверните в Kubernetes с помощью Maven

Quarkus в нативной среде Kubernetes. Вы можете легко развернуть приложение Quarkus в кластере Kubernetes без создания файлов YAML вручную. Для более сложных конфигураций, таких как, например, сопоставление секретов с переменными среды, вы можете использовать application.properties. Другие вещи, такие как, например, проверки работоспособности, обнаруживаются в исходном коде. Для этого нам нужно подключить quarkus-kubernetesмодуль. Также есть реализация для OpenShift.

<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-openshift</artifactId>
</dependency>

После этого Quarkus создаст манифесты развертывания во время сборки Maven. Мы можем включить автоматическое развертывание в текущем кластере Kubernetes, установив для свойства quarkus.kubernetes.deployзначение true. Для развертывания OpenShift мы должны изменить цель развертывания по умолчанию с kubernetesна openshift.

quarkus.container-image.build = true
quarkus.kubernetes.deploy = true
quarkus.kubernetes.deployment-target = openshift

Предположим, у нас есть некоторая пользовательская конфигурация для установки в Deploymentманифесте. Наше приложение будет работать в двух модулях и автоматически будет отображаться за пределами кластера. Он также вводит значения Secretдля подключения к базе данных PostgreSQL.

quarkus.openshift.expose = true
quarkus.openshift.replicas = 2
quarkus.openshift.labels.app = person-app
quarkus.openshift.annotations.app-type = demo
quarkus.openshift.env.mapping.postgres_user.from-secret = person-db
quarkus.openshift.env.mapping.postgres_user.with-key = database-user
quarkus.openshift.env.mapping.postgres_password.from-secret = person-db
quarkus.openshift.env.mapping.postgres_password.with-key = database-password
quarkus.openshift.env.mapping.postgres_db.from-secret = person-db
quarkus.openshift.env.mapping.postgres_db.with-key = database-name

Затем нам просто нужно собрать наше приложение с помощью Maven. В качестве альтернативы мы можем удалить это quarkus.kubernetes.deployсвойство application.propertiesи включить его в команде Maven.

$ maven clean package -D<meta charset="utf-8">quarkus.kubernetes.deploy=true

 

Совет 6. Получите доступ к консоли Dev UI

После запуска приложения Quarkus в режиме разработки ( mvn<em> </em>quarkus:dev) вы можете получить доступ к консоли Dev UI по адресу http://localhost:8080/q/dev . Чем больше модулей вы включаете, тем больше параметров вы можете там настроить. Одна из моих любимых функций здесь — возможность развертывания приложений в OpenShift. Вместо запуска команды Maven для создания приложения мы можем просто запустить его в devрежиме и развернуть с помощью графического интерфейса.

quarkus-советы-dev-ui

 

Совет 7. Постоянно тестируйте

Quarkus поддерживает непрерывное тестирование, когда тесты запускаются сразу после изменения кода. Это позволяет вам мгновенно получать отзывы об изменениях кода. Quarkus определяет, какие тесты покрывают какой код, и использует эту информацию для запуска соответствующих тестов только при изменении кода. После запуска приложения в разработке вам будет предложено включить эту функцию, как показано ниже. Просто нажмите r, чтобы включить его.

Итак, давайте добавим несколько тестов для нашего примера приложения. Во-первых, нам нужно включить тестовый модуль Quarkus и библиотеку REST Assured.

<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-junit5</artifactId>
   <scope>test</scope>
</dependency>
<dependency>
   <groupId>io.rest-assured</groupId>
   <artifactId>rest-assured</artifactId>
   <scope>test</scope>
</dependency>

Затем мы добавим несколько простых тестов API. Тестовый класс должен быть аннотирован с помощью @QuarkusTest. В остальном реализация типична для библиотеки REST Assured.

@QuarkusTest
public class PersonResourceTests {

    @Test
    void getPersons() {
        List<Person> persons = given().when().get("/persons")
                .then()
                .statusCode(200)
                .extract()
                .body()
                .jsonPath().getList(".", Person.class);
        assertEquals(persons.size(), 6);
    }

    @Test
    void getPersonById() {
        Person person = given()
                .pathParam("id", 1)
                .when().get("/persons/{id}")
                .then()
                .statusCode(200)
                .extract()
                .body().as(Person.class);
        assertNotNull(person);
        assertEquals(1L, person.id);
    }

    @Test
    void newPersonAdd() {
        Person newPerson = new Person();
        newPerson.age = 22;
        newPerson.name = "TestNew";
        newPerson.gender = Gender.FEMALE;
        Person person = given()
                .body(newPerson)
                .contentType(ContentType.JSON)
                .when().post("/persons")
                .then()
                .statusCode(200)
                .extract()
                .body().as(Person.class);
        assertNotNull(person);
        assertNotNull(person.id);
    }
}

Мы также можем запускать эти тесты JUnit из консоли Dev UI. Во-первых, вы должны перейти в консоль Dev UI. Внизу страницы вы найдете модуль ответственного тестирования панели. Просто щелкните значок Результат теста , и вы увидите экран, подобный показанному ниже.

 

Совет 8. Скомпилируйте с помощью GraalVM на OpenShift

Вы можете легко создать и запустить собственный образ Quarkus GraalVM в OpenShift с помощью одной команды и сборщика ubi-quarkus-native-s2i. OpenShift создает приложение, используя подход S2I (исходный код 2 образа). Конечно, вам просто нужен работающий кластер OpenShift (например, локальный CRC или тестовая среда разработчика https://developers.redhat.com/products/codeready-containers/overview ) и ocклиент, установленный локально.

$ oc new-app --name person-native \
             --context-dir basic-with-db/person-app \
  quay.io/quarkus/ubi-quarkus-native-s2i:21.2-java11~https://github.com/piomin/openshift-quickstart.git

Совет 9. Откатывайте транзакцию после каждого теста

Если вам нужно откатить изменения в данных после каждого теста, не делайте этого вручную. Вместо этого вам просто нужно аннотировать свой тестовый класс с помощью @TestTransaction. Откат выполняется каждый раз, когда метод тестирования завершается.

@QuarkusTest
@TestTransaction
public class PersonRepositoryTests {

    @Inject
    PersonRepository personRepository;

    @Test
    void addPerson() {
        Person newPerson = new Person();
        newPerson.age = 22;
        newPerson.name = "TestNew";
        newPerson.gender = Gender.FEMALE;
        personRepository.persist(newPerson);
        Assertions.assertNotNull(newPerson.id);
    }
}

 

Совет 10. Воспользуйтесь преимуществами поддержки GraphQL

Это последний совет Quarkus в этой статье. Тем не менее, это одна из моих любимых функций Quarkus. Поддержка GraphQL не является сильной стороной Spring Boot. С другой стороны, Quarkus предоставляет очень классные и простые расширения для GraphQL для клиента и сервера.

Во-первых, добавим модули Quarkus, отвечающие за поддержку GraphQL.

<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-smallrye-graphql</artifactId>
</dependency>
<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-smallrye-graphql-client</artifactId>
   <scope>test</scope>
</dependency>

Затем мы можем создать код, отвечающий за предоставление GraphQL API. Класс должен быть аннотирован с помощью @GraphQLAPI. Quarkus автоматически генерирует схему GraphQL из исходного кода.

@GraphQLApi
public class EmployeeFetcher {

    private EmployeeRepository repository;

    public EmployeeFetcher(EmployeeRepository repository){
        this.repository = repository;
    }

    @Query("employees")
    public List<Employee> findAll() {
        return repository.listAll();
    }

    @Query("employee")
    public Employee findById(@Name("id") Long id) {
        return repository.findById(id);
    }

    @Query("employeesWithFilter")
    public List<Employee> findWithFilter(@Name("filter") EmployeeFilter filter) {
        return repository.findByCriteria(filter);
    }

}

Затем давайте создадим клиентский интерфейс для вызова двух конечных точек. Нам нужно аннотировать этот интерфейс с помощью @GraphQLClientApi.

@GraphQLClientApi(configKey = "employee-client")
public interface EmployeeClient {

    List<Employee> employees();
    Employee employee(Long id);
}

Наконец, мы можем добавить простой тест JUnit. Нам просто нужно внедрить EmployeeClient, а затем вызвать методы. Если вас интересуют более подробные сведения о поддержке Quarkus GraphQL, прочитайте мою статью An Advanced GraphQL with Quarkus .

@QuarkusTest
public class EmployeeFetcherTests {

    @Inject
    EmployeeClient employeeClient;

    @Test
    void fetchAll() {
        List<Employee> employees = employeeClient.employees();
        Assertions.assertEquals(10, employees.size());
    }

    @Test
    void fetchById() {
        Employee employee = employeeClient.employee(10L);
        Assertions.assertNotNull(employee);
    }
}

Заключительные мысли

На мой взгляд, Quarkus — очень интересный и перспективный фреймворк. С помощью этих советов вы легко сможете начать разработку своего первого приложения с помощью Quarkus. В каждом новом релизе появляются новые интересные функции. Так что, возможно, мне скоро придется обновить этот список советов по Quarkus.

Ссылка: https://piotrminkowski.com/2021/10/12/quarkus-tips-tricks-and-techniques/

#quarkus #java #tips

Samanta  Moore

Samanta Moore

1623834960

Top 10 Popular Java Frameworks Every Developer Should Know in 2021

Java frameworks are essentially blocks of pre-written code, to which a programmer may add his code to solve specific problems. Several Java frameworks exist, all of which have their pros and cons. All of them can be used to solve problems in a variety of fields and domains. Java frameworks reduce the amount of coding from scratch that programmers have to do to come up with a solution.

Table of Contents

#full stack development #frameworks #java #java frameworks #top 10 popular java frameworks every developer should know in 2021 #top 10 popular java frameworks

How to Create Arrays in Python

In this tutorial, you'll know the basics of how to create arrays in Python using the array module. Learn how to use Python arrays. You'll see how to define them and the different methods commonly used for performing operations on them.

This tutorialvideo on 'Arrays in Python' will help you establish a strong hold on all the fundamentals in python programming language. Below are the topics covered in this video:  
1:15 What is an array?
2:53 Is python list same as an array?
3:48  How to create arrays in python?
7:19 Accessing array elements
9:59 Basic array operations
        - 10:33  Finding the length of an array
        - 11:44  Adding Elements
        - 15:06  Removing elements
        - 18:32  Array concatenation
       - 20:59  Slicing
       - 23:26  Looping  


Python Array Tutorial – Define, Index, Methods

In this article, you'll learn how to use Python arrays. You'll see how to define them and the different methods commonly used for performing operations on them.

The artcile covers arrays that you create by importing the array module. We won't cover NumPy arrays here.

Table of Contents

  1. Introduction to Arrays
    1. The differences between Lists and Arrays
    2. When to use arrays
  2. How to use arrays
    1. Define arrays
    2. Find the length of arrays
    3. Array indexing
    4. Search through arrays
    5. Loop through arrays
    6. Slice an array
  3. Array methods for performing operations
    1. Change an existing value
    2. Add a new value
    3. Remove a value
  4. Conclusion

Let's get started!

What are Python Arrays?

Arrays are a fundamental data structure, and an important part of most programming languages. In Python, they are containers which are able to store more than one item at the same time.

Specifically, they are an ordered collection of elements with every value being of the same data type. That is the most important thing to remember about Python arrays - the fact that they can only hold a sequence of multiple items that are of the same type.

What's the Difference between Python Lists and Python Arrays?

Lists are one of the most common data structures in Python, and a core part of the language.

Lists and arrays behave similarly.

Just like arrays, lists are an ordered sequence of elements.

They are also mutable and not fixed in size, which means they can grow and shrink throughout the life of the program. Items can be added and removed, making them very flexible to work with.

However, lists and arrays are not the same thing.

Lists store items that are of various data types. This means that a list can contain integers, floating point numbers, strings, or any other Python data type, at the same time. That is not the case with arrays.

As mentioned in the section above, arrays store only items that are of the same single data type. There are arrays that contain only integers, or only floating point numbers, or only any other Python data type you want to use.

When to Use Python Arrays

Lists are built into the Python programming language, whereas arrays aren't. Arrays are not a built-in data structure, and therefore need to be imported via the array module in order to be used.

Arrays of the array module are a thin wrapper over C arrays, and are useful when you want to work with homogeneous data.

They are also more compact and take up less memory and space which makes them more size efficient compared to lists.

If you want to perform mathematical calculations, then you should use NumPy arrays by importing the NumPy package. Besides that, you should just use Python arrays when you really need to, as lists work in a similar way and are more flexible to work with.

How to Use Arrays in Python

In order to create Python arrays, you'll first have to import the array module which contains all the necassary functions.

There are three ways you can import the array module:

  • By using import array at the top of the file. This includes the module array. You would then go on to create an array using array.array().
import array

#how you would create an array
array.array()
  • Instead of having to type array.array() all the time, you could use import array as arr at the top of the file, instead of import array alone. You would then create an array by typing arr.array(). The arr acts as an alias name, with the array constructor then immediately following it.
import array as arr

#how you would create an array
arr.array()
  • Lastly, you could also use from array import *, with * importing all the functionalities available. You would then create an array by writing the array() constructor alone.
from array import *

#how you would create an array
array()

How to Define Arrays in Python

Once you've imported the array module, you can then go on to define a Python array.

The general syntax for creating an array looks like this:

variable_name = array(typecode,[elements])

Let's break it down:

  • variable_name would be the name of the array.
  • The typecode specifies what kind of elements would be stored in the array. Whether it would be an array of integers, an array of floats or an array of any other Python data type. Remember that all elements should be of the same data type.
  • Inside square brackets you mention the elements that would be stored in the array, with each element being separated by a comma. You can also create an empty array by just writing variable_name = array(typecode) alone, without any elements.

Below is a typecode table, with the different typecodes that can be used with the different data types when defining Python arrays:

TYPECODEC TYPEPYTHON TYPESIZE
'b'signed charint1
'B'unsigned charint1
'u'wchar_tUnicode character2
'h'signed shortint2
'H'unsigned shortint2
'i'signed intint2
'I'unsigned intint2
'l'signed longint4
'L'unsigned longint4
'q'signed long longint8
'Q'unsigned long longint8
'f'floatfloat4
'd'doublefloat8

Tying everything together, here is an example of how you would define an array in Python:

import array as arr 

numbers = arr.array('i',[10,20,30])


print(numbers)

#output

#array('i', [10, 20, 30])

Let's break it down:

  • First we included the array module, in this case with import array as arr .
  • Then, we created a numbers array.
  • We used arr.array() because of import array as arr .
  • Inside the array() constructor, we first included i, for signed integer. Signed integer means that the array can include positive and negative values. Unsigned integer, with H for example, would mean that no negative values are allowed.
  • Lastly, we included the values to be stored in the array in square brackets.

Keep in mind that if you tried to include values that were not of i typecode, meaning they were not integer values, you would get an error:

import array as arr 

numbers = arr.array('i',[10.0,20,30])


print(numbers)

#output

#Traceback (most recent call last):
# File "/Users/dionysialemonaki/python_articles/demo.py", line 14, in <module>
#   numbers = arr.array('i',[10.0,20,30])
#TypeError: 'float' object cannot be interpreted as an integer

In the example above, I tried to include a floating point number in the array. I got an error because this is meant to be an integer array only.

Another way to create an array is the following:

from array import *

#an array of floating point values
numbers = array('d',[10.0,20.0,30.0])

print(numbers)

#output

#array('d', [10.0, 20.0, 30.0])

The example above imported the array module via from array import * and created an array numbers of float data type. This means that it holds only floating point numbers, which is specified with the 'd' typecode.

How to Find the Length of an Array in Python

To find out the exact number of elements contained in an array, use the built-in len() method.

It will return the integer number that is equal to the total number of elements in the array you specify.

import array as arr 

numbers = arr.array('i',[10,20,30])


print(len(numbers))

#output
# 3

In the example above, the array contained three elements – 10, 20, 30 – so the length of numbers is 3.

Array Indexing and How to Access Individual Items in an Array in Python

Each item in an array has a specific address. Individual items are accessed by referencing their index number.

Indexing in Python, and in all programming languages and computing in general, starts at 0. It is important to remember that counting starts at 0 and not at 1.

To access an element, you first write the name of the array followed by square brackets. Inside the square brackets you include the item's index number.

The general syntax would look something like this:

array_name[index_value_of_item]

Here is how you would access each individual element in an array:

import array as arr 

numbers = arr.array('i',[10,20,30])

print(numbers[0]) # gets the 1st element
print(numbers[1]) # gets the 2nd element
print(numbers[2]) # gets the 3rd element

#output

#10
#20
#30

Remember that the index value of the last element of an array is always one less than the length of the array. Where n is the length of the array, n - 1 will be the index value of the last item.

Note that you can also access each individual element using negative indexing.

With negative indexing, the last element would have an index of -1, the second to last element would have an index of -2, and so on.

Here is how you would get each item in an array using that method:

import array as arr 

numbers = arr.array('i',[10,20,30])

print(numbers[-1]) #gets last item
print(numbers[-2]) #gets second to last item
print(numbers[-3]) #gets first item
 
#output

#30
#20
#10

How to Search Through an Array in Python

You can find out an element's index number by using the index() method.

You pass the value of the element being searched as the argument to the method, and the element's index number is returned.

import array as arr 

numbers = arr.array('i',[10,20,30])

#search for the index of the value 10
print(numbers.index(10))

#output

#0

If there is more than one element with the same value, the index of the first instance of the value will be returned:

import array as arr 


numbers = arr.array('i',[10,20,30,10,20,30])

#search for the index of the value 10
#will return the index number of the first instance of the value 10
print(numbers.index(10))

#output

#0

How to Loop through an Array in Python

You've seen how to access each individual element in an array and print it out on its own.

You've also seen how to print the array, using the print() method. That method gives the following result:

import array as arr 

numbers = arr.array('i',[10,20,30])

print(numbers)

#output

#array('i', [10, 20, 30])

What if you want to print each value one by one?

This is where a loop comes in handy. You can loop through the array and print out each value, one-by-one, with each loop iteration.

For this you can use a simple for loop:

import array as arr 

numbers = arr.array('i',[10,20,30])

for number in numbers:
    print(number)
    
#output
#10
#20
#30

You could also use the range() function, and pass the len() method as its parameter. This would give the same result as above:

import array as arr  

values = arr.array('i',[10,20,30])

#prints each individual value in the array
for value in range(len(values)):
    print(values[value])

#output

#10
#20
#30

How to Slice an Array in Python

To access a specific range of values inside the array, use the slicing operator, which is a colon :.

When using the slicing operator and you only include one value, the counting starts from 0 by default. It gets the first item, and goes up to but not including the index number you specify.

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#get the values 10 and 20 only
print(numbers[:2])  #first to second position

#output

#array('i', [10, 20])

When you pass two numbers as arguments, you specify a range of numbers. In this case, the counting starts at the position of the first number in the range, and up to but not including the second one:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])


#get the values 20 and 30 only
print(numbers[1:3]) #second to third position

#output

#rray('i', [20, 30])

Methods For Performing Operations on Arrays in Python

Arrays are mutable, which means they are changeable. You can change the value of the different items, add new ones, or remove any you don't want in your program anymore.

Let's see some of the most commonly used methods which are used for performing operations on arrays.

How to Change the Value of an Item in an Array

You can change the value of a specific element by speficying its position and assigning it a new value:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#change the first element
#change it from having a value of 10 to having a value of 40
numbers[0] = 40

print(numbers)

#output

#array('i', [40, 20, 30])

How to Add a New Value to an Array

To add one single value at the end of an array, use the append() method:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#add the integer 40 to the end of numbers
numbers.append(40)

print(numbers)

#output

#array('i', [10, 20, 30, 40])

Be aware that the new item you add needs to be the same data type as the rest of the items in the array.

Look what happens when I try to add a float to an array of integers:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#add the integer 40 to the end of numbers
numbers.append(40.0)

print(numbers)

#output

#Traceback (most recent call last):
#  File "/Users/dionysialemonaki/python_articles/demo.py", line 19, in <module>
#   numbers.append(40.0)
#TypeError: 'float' object cannot be interpreted as an integer

But what if you want to add more than one value to the end an array?

Use the extend() method, which takes an iterable (such as a list of items) as an argument. Again, make sure that the new items are all the same data type.

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#add the integers 40,50,60 to the end of numbers
#The numbers need to be enclosed in square brackets

numbers.extend([40,50,60])

print(numbers)

#output

#array('i', [10, 20, 30, 40, 50, 60])

And what if you don't want to add an item to the end of an array? Use the insert() method, to add an item at a specific position.

The insert() function takes two arguments: the index number of the position the new element will be inserted, and the value of the new element.

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#add the integer 40 in the first position
#remember indexing starts at 0

numbers.insert(0,40)

print(numbers)

#output

#array('i', [40, 10, 20, 30])

How to Remove a Value from an Array

To remove an element from an array, use the remove() method and include the value as an argument to the method.

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

numbers.remove(10)

print(numbers)

#output

#array('i', [20, 30])

With remove(), only the first instance of the value you pass as an argument will be removed.

See what happens when there are more than one identical values:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30,10,20])

numbers.remove(10)

print(numbers)

#output

#array('i', [20, 30, 10, 20])

Only the first occurence of 10 is removed.

You can also use the pop() method, and specify the position of the element to be removed:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30,10,20])

#remove the first instance of 10
numbers.pop(0)

print(numbers)

#output

#array('i', [20, 30, 10, 20])

Conclusion

And there you have it - you now know the basics of how to create arrays in Python using the array module. Hopefully you found this guide helpful.

Thanks for reading and happy coding!

#python #programming 

Connor Mills

Connor Mills

1670560264

Understanding Arrays in Python

Learn how to use Python arrays. Create arrays in Python using the array module. You'll see how to define them and the different methods commonly used for performing operations on them.
 

The artcile covers arrays that you create by importing the array module. We won't cover NumPy arrays here.

Table of Contents

  1. Introduction to Arrays
    1. The differences between Lists and Arrays
    2. When to use arrays
  2. How to use arrays
    1. Define arrays
    2. Find the length of arrays
    3. Array indexing
    4. Search through arrays
    5. Loop through arrays
    6. Slice an array
  3. Array methods for performing operations
    1. Change an existing value
    2. Add a new value
    3. Remove a value
  4. Conclusion

Let's get started!


What are Python Arrays?

Arrays are a fundamental data structure, and an important part of most programming languages. In Python, they are containers which are able to store more than one item at the same time.

Specifically, they are an ordered collection of elements with every value being of the same data type. That is the most important thing to remember about Python arrays - the fact that they can only hold a sequence of multiple items that are of the same type.

What's the Difference between Python Lists and Python Arrays?

Lists are one of the most common data structures in Python, and a core part of the language.

Lists and arrays behave similarly.

Just like arrays, lists are an ordered sequence of elements.

They are also mutable and not fixed in size, which means they can grow and shrink throughout the life of the program. Items can be added and removed, making them very flexible to work with.

However, lists and arrays are not the same thing.

Lists store items that are of various data types. This means that a list can contain integers, floating point numbers, strings, or any other Python data type, at the same time. That is not the case with arrays.

As mentioned in the section above, arrays store only items that are of the same single data type. There are arrays that contain only integers, or only floating point numbers, or only any other Python data type you want to use.

When to Use Python Arrays

Lists are built into the Python programming language, whereas arrays aren't. Arrays are not a built-in data structure, and therefore need to be imported via the array module in order to be used.

Arrays of the array module are a thin wrapper over C arrays, and are useful when you want to work with homogeneous data.

They are also more compact and take up less memory and space which makes them more size efficient compared to lists.

If you want to perform mathematical calculations, then you should use NumPy arrays by importing the NumPy package. Besides that, you should just use Python arrays when you really need to, as lists work in a similar way and are more flexible to work with.

How to Use Arrays in Python

In order to create Python arrays, you'll first have to import the array module which contains all the necassary functions.

There are three ways you can import the array module:

  1. By using import array at the top of the file. This includes the module array. You would then go on to create an array using array.array().
import array

#how you would create an array
array.array()
  1. Instead of having to type array.array() all the time, you could use import array as arr at the top of the file, instead of import array alone. You would then create an array by typing arr.array(). The arr acts as an alias name, with the array constructor then immediately following it.
import array as arr

#how you would create an array
arr.array()
  1. Lastly, you could also use from array import *, with * importing all the functionalities available. You would then create an array by writing the array() constructor alone.
from array import *

#how you would create an array
array()

How to Define Arrays in Python

Once you've imported the array module, you can then go on to define a Python array.

The general syntax for creating an array looks like this:

variable_name = array(typecode,[elements])

Let's break it down:

  • variable_name would be the name of the array.
  • The typecode specifies what kind of elements would be stored in the array. Whether it would be an array of integers, an array of floats or an array of any other Python data type. Remember that all elements should be of the same data type.
  • Inside square brackets you mention the elements that would be stored in the array, with each element being separated by a comma. You can also create an empty array by just writing variable_name = array(typecode) alone, without any elements.

Below is a typecode table, with the different typecodes that can be used with the different data types when defining Python arrays:

TYPECODEC TYPEPYTHON TYPESIZE
'b'signed charint1
'B'unsigned charint1
'u'wchar_tUnicode character2
'h'signed shortint2
'H'unsigned shortint2
'i'signed intint2
'I'unsigned intint2
'l'signed longint4
'L'unsigned longint4
'q'signed long longint8
'Q'unsigned long longint8
'f'floatfloat4
'd'doublefloat8

Tying everything together, here is an example of how you would define an array in Python:

import array as arr 

numbers = arr.array('i',[10,20,30])


print(numbers)

#output

#array('i', [10, 20, 30])

Let's break it down:

  • First we included the array module, in this case with import array as arr .
  • Then, we created a numbers array.
  • We used arr.array() because of import array as arr .
  • Inside the array() constructor, we first included i, for signed integer. Signed integer means that the array can include positive and negative values. Unsigned integer, with H for example, would mean that no negative values are allowed.
  • Lastly, we included the values to be stored in the array in square brackets.

Keep in mind that if you tried to include values that were not of i typecode, meaning they were not integer values, you would get an error:

import array as arr 

numbers = arr.array('i',[10.0,20,30])


print(numbers)

#output

#Traceback (most recent call last):
# File "/Users/dionysialemonaki/python_articles/demo.py", line 14, in <module>
#   numbers = arr.array('i',[10.0,20,30])
#TypeError: 'float' object cannot be interpreted as an integer

In the example above, I tried to include a floating point number in the array. I got an error because this is meant to be an integer array only.

Another way to create an array is the following:

from array import *

#an array of floating point values
numbers = array('d',[10.0,20.0,30.0])

print(numbers)

#output

#array('d', [10.0, 20.0, 30.0])

The example above imported the array module via from array import * and created an array numbers of float data type. This means that it holds only floating point numbers, which is specified with the 'd' typecode.

How to Find the Length of an Array in Python

To find out the exact number of elements contained in an array, use the built-in len() method.

It will return the integer number that is equal to the total number of elements in the array you specify.

import array as arr 

numbers = arr.array('i',[10,20,30])


print(len(numbers))

#output
# 3

In the example above, the array contained three elements – 10, 20, 30 – so the length of numbers is 3.

Array Indexing and How to Access Individual Items in an Array in Python

Each item in an array has a specific address. Individual items are accessed by referencing their index number.

Indexing in Python, and in all programming languages and computing in general, starts at 0. It is important to remember that counting starts at 0 and not at 1.

To access an element, you first write the name of the array followed by square brackets. Inside the square brackets you include the item's index number.

The general syntax would look something like this:

array_name[index_value_of_item]

Here is how you would access each individual element in an array:

import array as arr 

numbers = arr.array('i',[10,20,30])

print(numbers[0]) # gets the 1st element
print(numbers[1]) # gets the 2nd element
print(numbers[2]) # gets the 3rd element

#output

#10
#20
#30

Remember that the index value of the last element of an array is always one less than the length of the array. Where n is the length of the array, n - 1 will be the index value of the last item.

Note that you can also access each individual element using negative indexing.

With negative indexing, the last element would have an index of -1, the second to last element would have an index of -2, and so on.

Here is how you would get each item in an array using that method:

import array as arr 

numbers = arr.array('i',[10,20,30])

print(numbers[-1]) #gets last item
print(numbers[-2]) #gets second to last item
print(numbers[-3]) #gets first item
 
#output

#30
#20
#10

How to Search Through an Array in Python

You can find out an element's index number by using the index() method.

You pass the value of the element being searched as the argument to the method, and the element's index number is returned.

import array as arr 

numbers = arr.array('i',[10,20,30])

#search for the index of the value 10
print(numbers.index(10))

#output

#0

If there is more than one element with the same value, the index of the first instance of the value will be returned:

import array as arr 


numbers = arr.array('i',[10,20,30,10,20,30])

#search for the index of the value 10
#will return the index number of the first instance of the value 10
print(numbers.index(10))

#output

#0

How to Loop through an Array in Python

You've seen how to access each individual element in an array and print it out on its own.

You've also seen how to print the array, using the print() method. That method gives the following result:

import array as arr 

numbers = arr.array('i',[10,20,30])

print(numbers)

#output

#array('i', [10, 20, 30])

What if you want to print each value one by one?

This is where a loop comes in handy. You can loop through the array and print out each value, one-by-one, with each loop iteration.

For this you can use a simple for loop:

import array as arr 

numbers = arr.array('i',[10,20,30])

for number in numbers:
    print(number)
    
#output
#10
#20
#30

You could also use the range() function, and pass the len() method as its parameter. This would give the same result as above:

import array as arr  

values = arr.array('i',[10,20,30])

#prints each individual value in the array
for value in range(len(values)):
    print(values[value])

#output

#10
#20
#30

How to Slice an Array in Python

To access a specific range of values inside the array, use the slicing operator, which is a colon :.

When using the slicing operator and you only include one value, the counting starts from 0 by default. It gets the first item, and goes up to but not including the index number you specify.


import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#get the values 10 and 20 only
print(numbers[:2])  #first to second position

#output

#array('i', [10, 20])

When you pass two numbers as arguments, you specify a range of numbers. In this case, the counting starts at the position of the first number in the range, and up to but not including the second one:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])


#get the values 20 and 30 only
print(numbers[1:3]) #second to third position

#output

#rray('i', [20, 30])

Methods For Performing Operations on Arrays in Python

Arrays are mutable, which means they are changeable. You can change the value of the different items, add new ones, or remove any you don't want in your program anymore.

Let's see some of the most commonly used methods which are used for performing operations on arrays.

How to Change the Value of an Item in an Array

You can change the value of a specific element by speficying its position and assigning it a new value:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#change the first element
#change it from having a value of 10 to having a value of 40
numbers[0] = 40

print(numbers)

#output

#array('i', [40, 20, 30])

How to Add a New Value to an Array

To add one single value at the end of an array, use the append() method:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#add the integer 40 to the end of numbers
numbers.append(40)

print(numbers)

#output

#array('i', [10, 20, 30, 40])

Be aware that the new item you add needs to be the same data type as the rest of the items in the array.

Look what happens when I try to add a float to an array of integers:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#add the integer 40 to the end of numbers
numbers.append(40.0)

print(numbers)

#output

#Traceback (most recent call last):
#  File "/Users/dionysialemonaki/python_articles/demo.py", line 19, in <module>
#   numbers.append(40.0)
#TypeError: 'float' object cannot be interpreted as an integer

But what if you want to add more than one value to the end an array?

Use the extend() method, which takes an iterable (such as a list of items) as an argument. Again, make sure that the new items are all the same data type.

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#add the integers 40,50,60 to the end of numbers
#The numbers need to be enclosed in square brackets

numbers.extend([40,50,60])

print(numbers)

#output

#array('i', [10, 20, 30, 40, 50, 60])

And what if you don't want to add an item to the end of an array? Use the insert() method, to add an item at a specific position.

The insert() function takes two arguments: the index number of the position the new element will be inserted, and the value of the new element.

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

#add the integer 40 in the first position
#remember indexing starts at 0

numbers.insert(0,40)

print(numbers)

#output

#array('i', [40, 10, 20, 30])

How to Remove a Value from an Array

To remove an element from an array, use the remove() method and include the value as an argument to the method.

import array as arr 

#original array
numbers = arr.array('i',[10,20,30])

numbers.remove(10)

print(numbers)

#output

#array('i', [20, 30])

With remove(), only the first instance of the value you pass as an argument will be removed.

See what happens when there are more than one identical values:


import array as arr 

#original array
numbers = arr.array('i',[10,20,30,10,20])

numbers.remove(10)

print(numbers)

#output

#array('i', [20, 30, 10, 20])

Only the first occurence of 10 is removed.

You can also use the pop() method, and specify the position of the element to be removed:

import array as arr 

#original array
numbers = arr.array('i',[10,20,30,10,20])

#remove the first instance of 10
numbers.pop(0)

print(numbers)

#output

#array('i', [20, 30, 10, 20])

Conclusion

And there you have it - you now know the basics of how to create arrays in Python using the array module. Hopefully you found this guide helpful.

You'll start from the basics and learn in an interacitve and beginner-friendly way. You'll also build five projects at the end to put into practice and help reinforce what you learned.

Thanks for reading and happy coding!

Original article source at https://www.freecodecamp.org

#python 

Best Android Mobile App Development Frameworks

Are you looking for the best Android app development frameworks? Get the best Android app development frameworks that help to build the top-notch Android mobile app.

For more info:
Website: https://www.appcluesinfotech.com/
Email: info@appcluesinfotech.com
Call: +1-978-309-9910

#best android mobile app development frameworks #top mobile app development frameworks #android app development frameworks #top frameworks for android app development #most popular android app development frameworks #app development frameworks