Kotlin Academy · Lección

Generar archivos fuente de Kotlin con KotlinPoet

Use KotlinPoet dentro de un procesador KSP para generar código Kotlin seguro respecto a tipos.

Generar archivos fuente de Kotlin con KotlinPoet es una lección gratuita de Kotlin Academy en CoddyKit. Esta es la lección 3 de 4. Puedes leer la lección completa abajo gratuitamente — luego la practicas en el navegador con un editor de código integrado y un tutor de IA 24/7. Forma parte de la ruta de aprendizaje de Kotlin Academy, y tu progreso se sincroniza en la web y la app de CoddyKit. El curso de Kotlin Academy incluye 4 lecciones en total.

¿Qué es KotlinPoet?

KotlinPoet es la API de Kotlin de Square para generar archivos de código fuente .kt mediante programación. Produce código Kotlin bien formateado e idiomático, y se integra de forma natural con CodeGenerator de KSP.

Adición de la dependencia

Añada KotlinPoet a su módulo de procesador:

dependencies {
    implementation("com.squareup:kotlinpoet:1.17.0")
    implementation("com.squareup:kotlinpoet-ksp:1.17.0") // KSP extensions
}

FileSpec: la raíz de un archivo generado

FileSpec.builder(packageName, fileName) es el punto de entrada. Añada tipos, funciones y propiedades, y después escriba el resultado mediante CodeGenerator de KSP:

val file = FileSpec.builder("com.example.generated", "MyFactory")
    .addType( /* TypeSpec here */ )
    .build()

TypeSpec: definición de una clase

Use TypeSpec.classBuilder() para las clases, objectBuilder() para los objetos y interfaceBuilder() para las interfaces. Encadene llamadas al constructor para añadir funciones, propiedades y superinterfaces:

val classSpec = TypeSpec.classBuilder("MyFactory")
    .addModifiers(KModifier.PUBLIC)
    .addFunction( /* FunSpec */ )
    .build()

FunSpec: generación de una función

FunSpec.builder(name) crea una función. Use addParameter(), returns() y addStatement() para construir su firma y cuerpo:

val funSpec = FunSpec.builder("create")
    .addParameter("name", String::class)
    .returns(String::class)
    .addStatement("return "Hello, %L!", name")
    .build()

PropertySpec: generación de una propiedad

Use PropertySpec.builder(name, type) para generar propiedades. Especifique KModifier.PRIVATE, KModifier.OVERRIDE o use mutable() para generar un var:

val propSpec = PropertySpec.builder("tag", String::class)
    .initializer("%S", "MyClass")
    .addModifiers(KModifier.PRIVATE)
    .build()

Especificadores de formato del código

KotlinPoet usa especificadores de formato en addStatement() e initializer():

%L — literal (sin comillas)
%S — literal de cadena (con comillas)
%T — nombre de tipo (gestiona las importaciones automáticamente)
%N — nombre (de una especificación o una cadena)

Importaciones automáticas con %T

Cuando usa %T con un ClassName, KotlinPoet añade automáticamente la importación necesaria. Nunca tiene que escribir las instrucciones de importación manualmente:

val listType = ClassName("kotlin.collections", "List")
val funSpec = FunSpec.builder("items")
    .returns(listType.parameterizedBy(String::class.asTypeName()))
    .addStatement("return emptyList()")
    .build()

Escritura en CodeGenerator de KSP

Use el puente kotlinpoet-ksp para escribir el FileSpec generado mediante CodeGenerator de KSP, conservando los metadatos de compilación incremental:

file.writeTo(
    codeGenerator = codeGenerator,
    aggregating = false
)

Generación de funciones de extensión

Use FunSpec.builder(name).receiver(type) para generar funciones de extensión:

val extFun = FunSpec.builder("toJson")
    .receiver(ClassName("com.example", "User"))
    .returns(String::class)
    .addStatement("return Gson().toJson(this)")
    .build()

Caso de uso práctico: generador de factorías

Un procesador de KSP anota clases de datos con @AutoFactory y usa KotlinPoet para generar un objeto factoría complementario para cada una. El archivo generado se coloca en el mismo paquete que la clase original.

Pruebas del código generado

Use FileSpec.toString() de KotlinPoet en las pruebas unitarias para comprobar el texto fuente generado sin escribirlo en el disco. La biblioteca kotlin-compile-testing-ksp puede compilar y ejecutar código generado en las pruebas.

Comprobación rápida

En KotlinPoet, ¿qué especificador de formato añade automáticamente la importación necesaria para una clase referenciada?

Recapitulación: generación de archivos fuente de Kotlin con KotlinPoet

Conclusiones clave:

FileSpec → archivo de nivel superior; TypeSpec → clase/objeto/interfaz; FunSpec → función; PropertySpec → propiedad
Utilice %T para las referencias de tipos; las importaciones se generan automáticamente
Escriba mediante file.writeTo(codeGenerator) en los procesadores de KSP
Utilice FileSpec.toString() para probar unitariamente el resultado generado

Preguntas frecuentes

¿La lección «Generar archivos fuente de Kotlin con KotlinPoet» es gratis?

Sí — el texto completo de «Generar archivos fuente de Kotlin con KotlinPoet» es gratis para leer aquí en la web. Para practicarla de forma interactiva (editor de código integrado y tutor de IA 24/7) y desbloquear el resto del curso de Kotlin Academy, actualiza a CoddyKit PRO. El curso de Kotlin Academy incluye 4 lecciones en total.

¿Qué aprenderé en «Generar archivos fuente de Kotlin con KotlinPoet»?

Use KotlinPoet dentro de un procesador KSP para generar código Kotlin seguro respecto a tipos. Practicas Kotlin Academy con código real que ejecutas directamente en el navegador, y un tutor de IA 24/7 responde tus preguntas mientras trabajas en la lección.

¿Necesito experiencia previa para empezar Kotlin Academy?

No se requiere experiencia previa. Kotlin Academy en CoddyKit está estructurado para principiantes hasta estudiantes avanzados, así que puedes empezar aquí o desde el inicio y avanzar a tu ritmo. Esta es la lección 3 de 4.

¿Cuánto tiempo toma la lección «Generar archivos fuente de Kotlin con KotlinPoet»?

La mayoría de las lecciones de CoddyKit toman alrededor de 5–10 minutos. Cada una es compacta e interactiva, así que avanzas constantemente y retomas exactamente por donde dejaste en la web y la app.

¿Puedo escribir y ejecutar código en esta lección de Kotlin Academy?

Sí. Cada lección de Kotlin Academy incluye un editor de código integrado, así que escribes y ejecutas código real directamente en tu navegador y obtienes retroalimentación instantánea de IA — sin configuración local necesaria.

Todas las lecciones de este curso

KSP frente a KAPT: por qué KSP es más rápido
Escribir su primer SymbolProcessor
Generar archivos fuente de Kotlin con KotlinPoet
Integrar procesadores KSP en una compilación de Gradle

← Volver a Kotlin Academy