Comienza a usar Java

Este instructivo está destinado a aquellos que estén comenzando a compilar aplicaciones en la nube, como ingenieros y desarrolladores web, que quieran aprender conceptos clave del desarrollo de aplicaciones y aplicarlos a Google Cloud.

Objetivos

• Aprender sobre las herramientas básicas de Google Cloud, como Google Cloud Console y gcloud
• Implementar tu app en Cloud Run
• Almacenar tus datos con Firestore
• Almacenar archivos subidos en Cloud Storage
• Supervisar la app mediante Google Cloud's operations suite

Costos

En este documento, usarás los siguientes componentes facturables de Google Cloud:

• Cloud Run
• Cloud Storage
• Firestore
• Google Cloud's operations suite

Las instrucciones de este documento están diseñadas para que el uso de los recursos se mantenga dentro de los límites del nivel Siempre gratuito de Google Cloud. Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios. Es posible que los usuarios nuevos de Google Cloud califiquen para obtener una prueba gratuita.

Cuando finalices las tareas que se describen en este documento, puedes borrar los recursos que creaste para evitar que continúe la facturación. Para obtener más información, consulta Cómo realizar una limpieza.

Antes de comenzar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

5. Make sure that billing is enabled for your Google Cloud project.

6. Para crear una base de datos de Firestore en modo nativo, sigue los pasos a continuación:
   1. En Cloud Console, ve a la página Visualizador de Firestore.
      Ir al visualizador de Firestore
   2. En la pantalla Selecciona un modo de Cloud Firestore, haz clic en Seleccionar modo nativo.
   3. Selecciona una ubicación para tu base de datos de Firestore. Esta configuración corresponde a la ubicación predeterminada de los recursos de Google Cloud que definiste en el proyecto de Cloud. La configuración de la ubicación se usa en los servicios de Google Cloud del proyecto que la requieren; en particular, el bucket predeterminado de Cloud Storage y la aplicación de Cloud Run.
      Advertencia: Una vez que configures la ubicación predeterminada de los recursos del proyecto de Cloud, no podrás cambiarla.
   4. Haga clic en Crear base de datos.

7. Enable the Cloud Run Admin, Cloud Storage, Cloud Logging, and Error Reporting APIs.

   Enable the APIs

8. Clona el repositorio de muestra y abre la aplicación de muestra en Cloud Shell:
   Ir a Cloud Shell

   Cloud Shell brinda acceso de línea de comandos a tus recursos de Google Cloud de forma directa desde el navegador.

9. Para descargar el código de muestra y cambiar al directorio de la app, haz clic en Continuar.

10. En Cloud Shell, configura la herramienta de gcloud para que use tu proyecto de Google Cloud nuevo de la manera siguiente:

    # Configure gcloud for your project
    gcloud config set project PROJECT_ID
    

    Reemplaza PROJECT_ID por el ID del proyecto de Google Cloud que creaste mediante Cloud Console.

    La CLI de Google Cloud es la forma principal de interactuar con los recursos de Google Cloud desde la línea de comandos. En este instructivo, usarás la herramienta gcloud para implementar y supervisar tu aplicación.

Ejecuta la app

1. Si ya usas Cloud Shell y lo configuraste para usar Java 11, actualiza las alternativas de Java de shell, JAVA_HOME y las variables de entorno PATH para especificar Java 8.
2. Cambia al directorio bookshelf/1-cloud-run y ejecuta la aplicación:

   GOOGLE_CLOUD_PROJECT=PROJECT_ID mvn -Plocal clean jetty:run-exploded
   

   Reemplaza PROJECT_ID por el ID del proyecto de Google Cloud que creaste.
3. En Cloud Shell, haz clic en Vista previa en la Web y selecciona Vista previa en el puerto 8080. Se abrirá una ventana nueva con tu app en ejecución.

Implementa tu app en Cloud Run

Google Cloud ofrece varias opciones para ejecutar tu código. Para este ejemplo usa Cloud Run a fin de implementar una app escalable en Google Cloud. Cloud Run no requiere que administres servidores ni se escala de forma automática para admitir los aumentos de tráfico.

1. Compila la imagen con Jib:
   mvn package jib:build -Dimage=gcr.io/PROJECT_ID/bookshelf

   Reemplaza PROJECT_ID por el ID del proyecto de Google Cloud que creaste.

2. Implementa la imagen:

   gcloud run deploy bookshelf --image gcr.io/PROJECT_ID/bookshelf \
   --platform managed --region us-central1 --allow-unauthenticated

   Reemplaza PROJECT_ID por el ID del proyecto de Google Cloud que creaste.

Cuando la implementación se realiza de forma correcta, se muestra un extremo de la app que se ejecuta en Cloud Run en el siguiente formato:

https://bookshelf-abcdefghij-uc.a.run.app

Tu app ya se puede visualizar en este enlace, que de ahora en más se llamará YOUR_CODE_RUN_URL. En tu navegador web, ingresa la URL para ver la app.

Almacena los datos con Firestore

No se puede almacenar información en tus instancias de Cloud Run porque se perderá si se reinicia la instancia, además de que no existirá cuando se creen instancias nuevas. En su lugar, usarás una base de datos en la que todas tus instancias puedan leer y escribir.

Google Cloud ofrece varias opciones para almacenar tus datos. En este ejemplo, usarás Firestore para almacenar los datos de cada libro. Firestore es una base de datos de documentos NoSQL, completamente administrada y sin servidores que te permite almacenar y consultar datos. Firestore escala de manera automática para cumplir las necesidades de tu aplicación y escala a cero cuando no la estás usando. Agrega el primer libro.

1. En tu navegador web, ve a YOUR_CODE_RUN_URL.

2. Para crear un libro en tu aplicación implementada, haz clic en Add book (Agregar libro).

   
3. En el campo Title, ingresa Moby Dick.
4. En el campo Author, ingresa Herman Melville.

5. Haz clic en Guardar. Ya tienes una entrada en la aplicación Bookshelf.

   
6. En Cloud Console, haz clic en Actualizar para actualizar la página de Firestore. Los datos aparecen en Firestore. La aplicación Bookshelf almacena cada libro como un documento de Firestore con un ID único, y todos estos documentos se almacenan en una colección de Firestore. Para los propósitos de este instructivo, la colección se llama “books”.

Firestore almacena los libros mediante la biblioteca cliente de Firestore. Aquí hay un ejemplo de recuperación de un documento de Firestore:

bookshelf/1-cloud-run/src/main/java/com/example/getstarted/daos/FirestoreDao.java

Ver en GitHub

public class FirestoreDao implements BookDao {
  private CollectionReference booksCollection;

  public FirestoreDao() {
    Firestore firestore = FirestoreOptions.getDefaultInstance().getService();
    booksCollection = firestore.collection("books");
  }

  private Book documentToBook(DocumentSnapshot document) {
    Map<String, Object> data = document.getData();
    if (data == null) {
      System.out.println("No data in document " + document.getId());
      return null;
    }

    return new Book.Builder()
        .author((String) data.get(Book.AUTHOR))
        .description((String) data.get(Book.DESCRIPTION))
        .publishedDate((String) data.get(Book.PUBLISHED_DATE))
        .imageUrl((String) data.get(Book.IMAGE_URL))
        .createdBy((String) data.get(Book.CREATED_BY))
        .createdById((String) data.get(Book.CREATED_BY_ID))
        .title((String) data.get(Book.TITLE))
        .id(document.getId())
        .build();
  }

  @Override
  public String createBook(Book book) {
    String id = UUID.randomUUID().toString();
    DocumentReference document = booksCollection.document(id);
    Map<String, Object> data = Maps.newHashMap();

    data.put(Book.AUTHOR, book.getAuthor());
    data.put(Book.DESCRIPTION, book.getDescription());
    data.put(Book.PUBLISHED_DATE, book.getPublishedDate());
    data.put(Book.TITLE, book.getTitle());
    data.put(Book.IMAGE_URL, book.getImageUrl());
    data.put(Book.CREATED_BY, book.getCreatedBy());
    data.put(Book.CREATED_BY_ID, book.getCreatedById());
    try {
      document.set(data).get();
    } catch (InterruptedException | ExecutionException e) {
      e.printStackTrace();
    }

    return id;
  }

  @Override
  public Book readBook(String bookId) {
    try {
      DocumentSnapshot document = booksCollection.document(bookId).get().get();

      return documentToBook(document);
    } catch (InterruptedException | ExecutionException e) {
      e.printStackTrace();
    }
    return null;
  }

  @Override
  public void updateBook(Book book) {
    DocumentReference document = booksCollection.document(book.getId());
    Map<String, Object> data = Maps.newHashMap();

    data.put(Book.AUTHOR, book.getAuthor());
    data.put(Book.DESCRIPTION, book.getDescription());
    data.put(Book.PUBLISHED_DATE, book.getPublishedDate());
    data.put(Book.TITLE, book.getTitle());
    data.put(Book.IMAGE_URL, book.getImageUrl());
    data.put(Book.CREATED_BY, book.getCreatedBy());
    data.put(Book.CREATED_BY_ID, book.getCreatedById());
    try {
      document.set(data).get();
    } catch (InterruptedException | ExecutionException e) {
      e.printStackTrace();
    }
  }

  @Override
  public void deleteBook(String bookId) {
    try {
      booksCollection.document(bookId).delete().get();
    } catch (InterruptedException | ExecutionException e) {
      e.printStackTrace();
    }
  }

  private List<Book> documentsToBooks(List<QueryDocumentSnapshot> documents) {
    List<Book> resultBooks = new ArrayList<>();
    for (QueryDocumentSnapshot snapshot : documents) {
      resultBooks.add(documentToBook(snapshot));
    }
    return resultBooks;
  }

  @Override
  public Result<Book> listBooks(String startTitle) {
    Query booksQuery = booksCollection.orderBy("title").limit(10);
    if (startTitle != null) {
      booksQuery = booksQuery.startAfter(startTitle);
    }
    try {
      QuerySnapshot snapshot = booksQuery.get().get();
      List<Book> results = documentsToBooks(snapshot.getDocuments());
      String newCursor = null;
      if (results.size() > 0) {
        newCursor = results.get(results.size() - 1).getTitle();
      }
      return new Result<>(results, newCursor);
    } catch (InterruptedException | ExecutionException e) {
      e.printStackTrace();
    }
    return new Result<>(Lists.newArrayList(), null);
  }

  @Override
  public Result<Book> listBooksByUser(String userId, String startTitle) {
    Query booksQuery =
        booksCollection.orderBy("title").whereEqualTo(Book.CREATED_BY_ID, userId).limit(10);
    if (startTitle != null) {
      booksQuery = booksQuery.startAfter(startTitle);
    }
    try {
      QuerySnapshot snapshot = booksQuery.get().get();
      List<Book> results = documentsToBooks(snapshot.getDocuments());
      String newCursor = null;
      if (results.size() > 0) {
        newCursor = results.get(results.size() - 1).getTitle();
      }
      return new Result<>(results, newCursor);
    } catch (InterruptedException | ExecutionException e) {
      e.printStackTrace();
    }
    return new Result<>(Lists.newArrayList(), null);
  }
}

Para obtener más información sobre el uso de Firestore, consulta cómo agregar datos a Firestore.

Almacena archivos subidos en Cloud Storage

Ahora que agregaste un libro, es momento de agregar su imagen de portada. No puedes almacenar archivos en tus instancias. Una base de datos no es la opción correcta para archivos de imagen. En cambio, debes usar Cloud Storage.

Cloud Storage es el almacenamiento de BLOB principal de Google Cloud. Puedes usar Cloud Storage a fin de alojar elementos de aplicaciones que deseas compartir en Google Cloud. Para usar Cloud Storage, debes crear un bucket de Cloud Storage, un contenedor básico en el que se guardan tus datos.

1. En Cloud Console, ve a la página Navegador de Cloud Storage.

   Ir a la página Navegador de Cloud Storage

2. Haga clic en Crear bucket.
3. En el cuadro de diálogo Crear bucket, adjunta el ID del proyecto de Google Cloud a la string _bucket para ingresar un nombre del bucket, de manera que sea similar a YOUR_PROJECT_ID_bucket. Este nombre está sujeto a los requisitos de nombres de los buckets. En el resto de los campos, se pueden conservar los valores predeterminados.
4. Haga clic en Crear.
5. Una vez que se haya creado el bucket, debe permitirse el acceso público a los objetos para que puedan consultarlos los usuarios. Si quieres permitir el acceso público a tus objetos, consulta el artículo Haz públicos los datos.
6. Haz clic en Edit book y selecciona una imagen para subirla como la portada del libro. Por ejemplo, puedes usar esta imagen de dominio público:
   
7. Haz clic en Save. Se te redireccionará a la página principal, en la que encontrarás una entrada a la app de Bookshelf.
   

La aplicación de Bookshelf envía los archivos subidos a Cloud Storage a través de la biblioteca cliente de Cloud Storage.

bookshelf/1-cloud-run/src/main/java/com/example/getstarted/util/CloudStorageHelper.java

Ver en GitHub

public class CloudStorageHelper {

  private final Logger logger = Logger.getLogger(CloudStorageHelper.class.getName());
  private static Storage storage = null;

  static {
    storage = StorageOptions.getDefaultInstance().getService();
  }

  /**
   * Uploads a file to Google Cloud Storage to the bucket specified in the BUCKET_NAME environment
   * variable, appending a timestamp to end of the uploaded filename.
   */
  public String uploadFile(FileItemStream fileStream, final String bucketName)
      throws IOException, ServletException {
    checkFileExtension(fileStream.getName());

    System.out.println("FileStream name: " + fileStream.getName() + "\nBucket name: " + bucketName);

    DateTimeFormatter dtf = DateTimeFormat.forPattern("-YYYY-MM-dd-HHmmssSSS");
    DateTime dt = DateTime.now(DateTimeZone.UTC);
    String dtString = dt.toString(dtf);
    final String fileName = fileStream.getName() + dtString;

    // the inputstream is closed by default, so we don't need to close it here
    @SuppressWarnings("deprecation")
    BlobInfo blobInfo =
        storage.create(
            BlobInfo.newBuilder(bucketName, fileName)
                // Modify access list to allow all users with link to read file
                .setAcl(new ArrayList<>(Arrays.asList(Acl.of(User.ofAllUsers(), Role.READER))))
                .build(),
            fileStream.openStream());
    logger.log(
        Level.INFO, "Uploaded file {0} as {1}", new Object[] {fileStream.getName(), fileName});
    // return the public download link
    return blobInfo.getMediaLink();
  }

  /** Checks that the file extension is supported. */
  private void checkFileExtension(String fileName) throws ServletException {
    if (fileName != null && !fileName.isEmpty() && fileName.contains(".")) {
      String[] allowedExt = {".jpg", ".jpeg", ".png", ".gif"};
      for (String ext : allowedExt) {
        if (fileName.endsWith(ext)) {
          return;
        }
      }
      throw new ServletException("file must be an image");
    }
  }
}

Nota: Para cambiar el nombre del bucket, configura la variable bucketName del código anterior con un nombre diferente y vuelve a implementar la app ejecutando gcloud app deploy.

Para obtener más información sobre cómo usar Cloud Storage, consulta la lista de guías prácticas.

Supervisa la app con Google Cloud's operations suite

Ya implementaste la app y creaste y modificaste libros. A fin de supervisar estos eventos para los usuarios, usa la administración del rendimiento de las aplicaciones.

Supervisa los registros con Cloud Logging

1. En Google Cloud, ve al Explorador de registros

   Ir al Explorador de registros

   Puedes supervisar tu app en tiempo real. Si tienes problemas con tu app, este es uno de los primeros lugares que consultar.

   
2. En la lista desplegable Recursos, selecciona Revisión de Cloud Run, bookshelf.

Supervisa los errores con Error Reporting

1. En Cloud Console, ve a la página Error Reporting.
   Ir a la página Error Reporting
   Error Reporting destaca los errores y las excepciones de la app y te permite configurar alertas basadas en ellos.
2. En el navegador, ve a la URL /errors de tu aplicación.
   

   YOUR_CODE_RUN_URL/errors

   Esto genera una nueva excepción de prueba y la envía al paquete de operaciones de Google Cloud.

3. En Cloud Console, regrese a la página de Error Reporting y podrá ver el error nuevo en unos instantes. Haz clic en Volver a cargar automáticamente para no tener que actualizar la página de forma manual.

   

Nota: La administración del rendimiento de las aplicaciones cuenta con varias herramientas para ayudarte a depurar y supervisar las apps. Para obtener más información, consulta los instructivos.

Limpia

Para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos usados en este instructivo, borra el proyecto que contiene los recursos o conserva el proyecto y borra los recursos individuales.

Borra el proyecto

Precaución: Borrar un proyecto tiene las siguientes consecuencias:

• Se borra todo en el proyecto. Si usaste un proyecto existente para las tareas de este documento, cuando lo borres, también se borrará cualquier otro trabajo que hayas realizado en el proyecto.
• Se pierden los ID personalizados de proyectos. Cuando creaste este proyecto, es posible que hayas creado un ID del proyecto personalizado que desees utilizar en el futuro. Para conservar las URL que utilizan el ID del proyecto, como una URL appspot.com, borra los recursos seleccionados dentro del proyecto en lugar de borrar todo el proyecto.

Si planeas explorar varias infraestructuras, instructivos y guías de inicio rápido la reutilización de proyectos puede ayudarte a evitar exceder los límites de las cuotas del proyecto.

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

¿Qué sigue?

• Implementa una app en Google Kubernetes Engine
• Implementa una aplicación en Compute Engine
• Maneja sesiones con Firestore