Skip to content

Dedicated chapter about code generation configuration #1850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 40 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
96f0cfe
First draft
vmikhailenko May 15, 2025
d736bf8
Add two switches
vmikhailenko May 15, 2025
c7cb8a5
Feedback
vmikhailenko May 16, 2025
28a33a9
Feedback
vmikhailenko May 16, 2025
83d4d87
Feedback
vmikhailenko May 16, 2025
99fd58d
Update
vmikhailenko May 16, 2025
ec69759
Update
vmikhailenko May 16, 2025
beecdc0
Update
vmikhailenko May 16, 2025
1fd9a5f
Add an example
vmikhailenko May 19, 2025
c4c734b
Update java/developing-applications/configuring.md
vmikhailenko May 19, 2025
498299f
Merge branch 'main' into codegen-switches-explained
vmikhailenko May 22, 2025
d61ed74
Move the chapter
vmikhailenko Jun 16, 2025
9cc0876
Merge remote-tracking branch 'origin/codegen-switches-explained' into…
vmikhailenko Jun 16, 2025
3457d84
Merge branch 'main' into codegen-switches-explained
vmikhailenko Jun 16, 2025
75e7b7c
Fix broken link
vmikhailenko Jun 16, 2025
bfbb38e
Merge remote-tracking branch 'origin/codegen-switches-explained' into…
vmikhailenko Jun 16, 2025
179e9f7
Add 'cqnServiceGetters'
vmikhailenko Jul 3, 2025
44cb70c
Merge branch 'main' into codegen-switches-explained
vmikhailenko Jul 29, 2025
d1494f5
Reorder rules
vmikhailenko Jul 29, 2025
9857584
Feedback
vmikhailenko Jul 30, 2025
723352f
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
593c48f
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
44b9f0b
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
16eb9d3
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
d8ea52e
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
b592f45
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
2efc64f
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
291e51d
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
9bb1805
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
7696ff0
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
46a8e71
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
d0c06c9
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
ae9235b
Update java/developing-applications/building.md
vmikhailenko Jul 31, 2025
122191a
Feedback
vmikhailenko Jul 31, 2025
464a027
Update java/developing-applications/building.md
agoerler Jul 31, 2025
62743a8
Update java/developing-applications/building.md
vmikhailenko Aug 22, 2025
c6ec091
Update java/developing-applications/building.md
vmikhailenko Aug 22, 2025
8c203e7
Update java/developing-applications/building.md
vmikhailenko Aug 22, 2025
5fed059
Apply suggestions from code review
vmikhailenko Aug 22, 2025
7b03d28
Fix markup
vmikhailenko Aug 22, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 3 additions & 18 deletions java/cds-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -473,24 +473,7 @@ The name of the CDS element referred to by a getter or setter, is defined throug

### Generated Accessor Interfaces {#generated-accessor-interfaces}

For all structured types of the CDS model, accessor interfaces can be generated using the [CDS Maven Plugin](./cqn-services/persistence-services#staticmodel). The generated accessor interfaces allow for hybrid access and easy serialization to JSON.

By default, the accessor interfaces provide the setter and getter methods inspired by the JavaBeans specification.

Following example uses accessor interfaces that have been generated with the default (JavaBeans) style:

```java
Authors author = Authors.create();
author.setName("Emily Brontë");

Books book = Books.create();
book.setAuthor(author);
book.setTitle("Wuthering Heights");
```

Alternatively, you can generate accessor interfaces in _fluent style_. In this mode, the getter methods are named after the property names. To enable fluent chaining, the setter methods return the accessor interface itself.

Following is an example of the fluent style:
For all structured types of the CDS model, accessor interfaces can be generated using the [CDS Maven Plugin](/java/assets/cds-maven-plugin-site/plugin-info.html). The generated accessor interfaces allow for hybrid access and easy serialization to JSON. Code generation is executed by default at build time and is configurable.

```java
Authors author = Authors.create().name("Emily Brontë");
Expand All @@ -505,6 +488,8 @@ The way the interfaces are generated determines only how data is accessed by cus

Moreover, it doesn't change the way how event contexts and entities, delivered by CAP, look like. Such interfaces from CAP are always modelled in the default JavaBeans style.

See more in [Configuring Code Generation for Typed Access](/java/developing-applications/building#codegen-config) for advanced options. {.learn-more}

#### Renaming Elements in Java

Element names used in the CDS model might conflict with reserved [Java keywords](https://docs.oracle.com/javase/specs/jls/se13/html/jls-3.html#jls-3.9) (`class`, `private`, `transient`, etc.). In this case, the `@cds.java.name` annotation must be used to specify an alternative property name that will be used for the generation of accessor interfaces and [static model](./cqn-services/persistence-services#staticmodel) interfaces. The element name used as key in the underlying map for [dynamic access](#entities-and-structured-types) isn't affected by this annotation.
Expand Down
145 changes: 143 additions & 2 deletions java/developing-applications/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,148 @@ Use the _.cdsrc.json_ file to add project specific configuration of `@sap/cds-dk
[Learn more about configuration and `cds.env`](../../node.js/cds-env){.learn-more}


### Using a Local cds-dk
## Code Generation for Typed Access {#codegen-config}

The [interfaces for typed access](../cds-data#generated-accessor-interfaces) are generated at each build
by the [`cds:generate`](/java/assets/cds-maven-plugin-site/generate-mojo.html) goal of the [CDS Maven Plugin](/java/assets/cds-maven-plugin-site/plugin-info.html).

You configure this goal just like any other Maven plugin via its configuration options via your application's POM. For example:

```xml [pom.xml]
<execution>
<id>cds.generate</id>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<basePackage>cds.gen</basePackage>
...
</configuration>
</execution>
```

Each time your application is built, these interfaces are regenerated. By default, they are excluded from your version control.

### Package for Generated Code

The option [`basePackage`](/java/assets/cds-maven-plugin-site/generate-mojo.html#basePackage) can be used to specify a base package prefix for generated code. The suffix package structure will reflect namespaces defined in your CDS model.

### Filter for CDS Entities

By default, the complete model of your application is generated including all imported or re-used models.
You can use options [`includes`](/java/assets/cds-maven-plugin-site/generate-mojo.html#includes) and [`excludes`](/java/assets/cds-maven-plugin-site/generate-mojo.html#excludes) to specify the part of your overall model that is subject to code generation. Both inclusion and exclusion can be used together, inclusion is evaluated first, then exclusion filters out of the included set of entities.

These options use patterns that are applied on the fully qualified names of the entities in CDS models. For example, the pattern `my.bookshop.*` will cover all definitions with namespace `my.bookshop` and the pattern `my.bookshop.**` will cover all definitions with fully qualified name starting with `my.bookshop`.

:::warning Cross-namespace references are not resolved
Options `includes` and `excludes` are simple filters. If included parts of your model reference types from the excluded area, the resulting code will not compile.
:::

### Style of Interfaces

By default, the accessor interfaces provide the setter and getter methods inspired by the JavaBeans specification. In this style, getter and setter method names are prefixed with `get` and `set`:


```java
Authors author = Authors.create();
author.setName("Emily Brontë");

Books book = Books.create();
book.setAuthor(author);
book.setTitle("Wuthering Heights");
```

Alternatively, you can generate accessor interfaces in _fluent style_. In this mode, the getter methods are named after the property names. To enable fluent chaining, the setter methods return the accessor interface itself:


```java
Authors author = Authors.create().name("Emily Brontë");
Books.create().author(author).title("Wuthering Heights");
```

The generation mode is configured by the option [`methodStyle`](/java/assets/cds-maven-plugin-site/generate-mojo.html#methodStyle). The selected style affects all entities and event contexts in your services. The default value is `BEAN`, which represents JavaBeans-style interfaces.

Once, when starting a project, decide on the style of the interfaces that is best for your team and project.

The way the interfaces are generated only determines how data is accessed by custom code. It does not affect how the data is represented in memory and handled by the CAP Java runtime.

Moreover, it doesn't change the way how event contexts, delivered by CAP, look like. Such interfaces from CAP are always modelled in the default JavaBeans style.

### Code Generation Features

Other options in this goal enable or disable certain features that change the way generated code looks in a certain aspect. These changes can be incompatible with the existing code and require manual adaptation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes can be incompatible with the existing code and require manual adaptation.

This also applied to the methodStyle. The difference is that methodStyle is a question of taste. But strictSetters and interfacesForAspects, ... are recommended setting. We just don't change the default to avoid breaking existing code.


- [`strictSetters`](/java/assets/cds-maven-plugin-site/generate-mojo.html#strictSetters)

This switch changes the signature of the setter methods in typed access interfaces so that they require concrete type instead of generic `Map` interface.
For example:

```java
void setManager(Map<String, ?> manager); // [!code --]
void setManager(Manager manager); // [!code ++]
```

It does not introduce any additional type checks at runtime, the correctness of the assignment is checked only at the time of compilation.

- [`interfacesForAspects`](/java/assets/cds-maven-plugin-site/generate-mojo.html#interfacesForAspects)

If your entity is modelled with the [composition of aspects](/cds/cdl#with-named-targets), the generated interfaces always reference original aspect as type for setters and getters.
When this switch is enabled, the code generator uses the type generated by the compiler instead of the type of the aspect itself and will include methods to fetch keys, for example.

:::warning Limitations
This is supported only for the named aspects (inline targets are not supported) and does not respect all possible options how such entities might be exposed by services.
:::

- [`betterNames`](/java/assets/cds-maven-plugin-site/generate-mojo.html#betterNames)

CDS models from external sources might include elements that have some special characters in their names or include elements that clash with Java keywords. Such cases always can be solved with the [renaming features](/java/cds-data#renaming-elements-in-java) provided by code generator, but in case of large models, this is tedious.
When this switch is enabled, characters `/` and `$` behave as a separators for the name during case conversions, similar to `_` and `.`. For example, `GET_MATERIAL` yields `GetMaterial` (or `getMaterial` for attributes and methods). The same now applies for the names with `/`, for example, name `/DMO/GET_MATERIAL` will be converted to `DmoGetMaterial`.

The following conversions are applied:
- Names from CDS model that are Java keywords are suffixed with `_`.
- Names from CDS model that use characters that are not valid as Java identifiers, are replaced by `_`. This, however, might lead to a conflicts between names that yield the same name in Java.
- Leading `_` will remain in the name after conversions. This supports conventions where an association and its foreign key have names like `_assoc` and `assoc`.
These conversions no longer influence the splitting.

- [`cqnServiceGetters`](/java/assets/cds-maven-plugin-site/generate-mojo.html#cqnServiceGetters)

The method `getService()` in generated [event-specific Event Context interfaces](../event-handlers/#eventcontext) is overridden to return the typed service interface instead of the generic `Service` type.

:::warning Check migration guides!
In major releases of CAP Java, some of these switches can be made the new default and some other switches might be removed. This might introduce compile errors
in your application that needs to be fixed.
:::

See [Maven Plugin Documentation](/java/assets/cds-maven-plugin-site/generate-mojo.html) for actual status of deprecation and switches that are not described here. {.learn-more}

### Annotation Detail Level

The option [`annotationDetailLevel`](/java/assets/cds-maven-plugin-site/generate-mojo.html#annotationDetailLevel) lets you choose the amount of the details for the Java annotation [`@Generated`](https://docs.oracle.com/en/java/javase/21/docs/api/java.compiler/javax/annotation/processing/Generated.html) added to each interface. This annotation has no effect at runtime but is evaluated by static code analysis tools to identify the artifacts as generated.

Following levels of the details are available:
- `MINIMAL` (default) - only the annotation is added, no additional information is added.

```java
@CdsName("service.Entity")
@Generated("cds-maven-plugin")
public interface Entity extends CdsData { }
```

- `FULL` - annotation contains the timestamp of the generation.

```java
@CdsName("service.Entity")
@Generated(
value = "cds-maven-plugin",
date = "9999-12-31T23:59:59.999999Z",
comments = ""
)
public interface Entity extends CdsData { }
```

- `NONE` - no `@Generated` annotation is added. This is not recommended.

## Using a Local cds-dk

Starting with version 3.6.0 of the `cds-services-archetype`, the default setup of a newly created CAP Java project has changed. The `@sap/cds-dk` is maintained as a `devDependency` in `package.json` and installed with an `npm ci` during the Maven build.
The `install-cdsdk` goal is no longer used to install the `@sap/cds-dk` locally and it's also marked as deprecated. The version of the `@sap/cds-dk` is no longer maintained in _pom.xml_, it's configured in the _package.json_:
Expand All @@ -395,7 +536,7 @@ A `package-lock.json` is also created during project creation with the `cds-serv
For multitenant applications, ensure that the `@sap/cds-dk` version in the sidecar is in sync.
:::

#### Migrate From Goal `install-cdsdk` to `npm ci`
### Migrate From Goal `install-cdsdk` to `npm ci`
{ #migration-install-cdsdk }

To migrate from the deprecated goal `install-cdsdk` to the new `npm ci` approach, the following steps are required:
Expand Down
2 changes: 1 addition & 1 deletion java/developing-applications/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ properties:

:::warning SAP Business Application Studio
If you develop your application in SAP Business Application Studio and Java 21 is not available there, use the Java 17, instead.
:::
:::