Directrices de codificación de Kintone

Contenido

Visión general

Mediante el uso de las funciones de "Personalización de JavaScript / CSS" de Kintone, la interfaz de usuario y las características de Kintone y sus aplicaciones se pueden personalizar.
En esta página se presentan las directrices para la personalización de JavaScript de Kintone que debe leer antes de empezar a codificar las personalizaciones de Kintone.
Consulte nuestras páginas de ayuda de Kintone para obtener más información sobre cómo aplicar la personalización de JavaScript a sus aplicaciones.

Directrices de codificación

Codificación de caracteres

Utilice siempre UTF-8 sin lista de materiales.

Espacios de nombres y variables

No sobrescriba los objetos globales existentes.
Declare variables locales dentro del ámbito de las funciones anónimas o dentro del ámbito de los bloques. No declare variables como variables globales.

Si es necesario utilizar una variable entre ámbitos de función, utilice una de las siguientes opciones:

  • Usar empaquetadores de JavaScript como webpack
  • Usar un objeto de espacio de nombres
Evite usar o sobrescribir variables globales
1
2
3
4
(() => {
  globalVariable = 1; // Do not declare global variables.
  const localVariable = 1; // Instead declare your local variables within the immediately invoked function.
})();

Declarar variables dentro del ámbito de los bloques

1
2
3
4
5
6
7
8
{
  // Bad Practice: globalVariable is overwritten due to overlapping scope and using var to declare.
  globalVariable1 = 1;
  var globalVariable2 = 1;
  // Good Practice: Variables are declared locally, within the block scope, as declaring variables with let respects block scope.
  const localVariable1 = 1;
  let localVariable2 = 1;
}
Agregar o hacer referencia a objetos existentes en lugar de editarlos
1
2
3
4
5
6
7
8
(() => {
  // Bad Practices:
  kintone.foo = 'bar'; // Do not edit the existing global object.
  const foo = kintone.foo; // Avoid referencing global objects.
  // Good Practices:
  myNameSpace = {}; // Create a new object instead.
  myNameSpace.foo = 'bar'; // Add the desired properties to that object.
})();

Atributos id/class que se utilizan en Kintone

Los atributos id/class de cada elemento utilizado en Kintone pueden ser cambiados sin previo aviso.
La estructura del DOM también puede cambiar sin previo aviso.

Al crear personalizaciones de Kintone, absténgase de editar lo siguiente:

  • id o class de elementos HTML
  • La estructura DOM de cualquier elemento que no se obtenga a través de la API de JavaScript de Kintone

Al editar el DOM, se recomienda encarecidamente utilizar la API de JavaScript de Kintone, ya que el classname, id u otras propiedades del DOM pueden ser cambiadas en cualquier momento sin previo aviso por Kintone.

Personalización en elementos recuperados con API de JavaScript

Como el CSS de Kindone puede afectar a los elementos, es posible que no siempre tengan el mismo aspecto.
Para ver las API que pueden obtener elementos, consulte el siguiente vínculo:
API de JavaScript de Kintone: Obtener elementos

Recuperación de la URL

Utilice la función kintone.api.url() o el kintone.api.urlForGet() para recuperar la URL de Kintone.

Contenidos que no se pueden personalizar con la API de JavaScript y CSS

Las siguientes páginas de la aplicación no ejecutarán sus personalizaciones de JavaScript/CSS si se adjuntan a cuerpos de espacios/subprocesos/anuncios:

  • Lista de registros
  • Gráfico

Comprobar operaciones en varios navegadores web

Se recomienda utilizar diferentes navegadores web para probar la personalización.
Dependiendo del programa JavaScript que se cargue en Kintone, es posible que algunas funciones de Kintone no funcionen correctamente.
Compruebe que la personalización funciona correctamente en diferentes tipos y versiones de navegador.
Para conocer los requisitos del sistema de Kintone, consulte la siguiente página
Requisitos del sistema (External link)

Considere el efecto en el servicio Kintone

Evite enviar grandes cantidades de solicitudes en un corto período de tiempo

Los programas automatizados que envían numerosas solicitudes o ejecutan varias solicitudes paralelas pueden degradar el rendimiento y ralentizar las respuestas. Tenga en cuenta que las solicitudes excesivas que imponen una carga pesada en nuestros servidores pueden resultar en restricciones de acceso en su entorno Kintone.

Establecer un agente de usuario adecuado

Establezca un valor apropiado en el encabezado User-Agent, para que podamos identificar de qué servicios o herramientas provienen las solicitudes.
Consulte las directrices sobre agentes de usuario a través del siguiente enlace:

Efectos de las actualizaciones de Kintone

Después de que Kintone tenga una actualización, puede existir la posibilidad de que los archivos JavaScript y CSS que cargó no funcionen correctamente. En este caso, edite el contenido del archivo y vuelva a cargarlo.
Para reducir en gran medida la posibilidad de que esto suceda, asegúrese de leer los documentos de la API de JavaScript y use la API de JavaScript de Kintone en sus códigos.

Política de cambios para las especificaciones de API públicas

Seguridad

Para evitar problemas de seguridad de sus programas JavaScript, cree sus programas siguiendo la siguiente guía:
Directrices de codificación segura