Skip to content

Commit c7e5efa

Browse files
authored
config docs fix (#199)
1 parent e7cdd1b commit c7e5efa

File tree

2 files changed

+33
-12
lines changed

2 files changed

+33
-12
lines changed

database/database-common/src/main/java/ru/tinkoff/kora/database/common/telemetry/DefaultDataBaseLogger.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public void logQueryBegin(QueryContext queryContext) {
3232
});
3333

3434
if (log.isDebugEnabled()) {
35-
log.debug(marker, "SQL executing for pool '{}':\n{}",this.poolName, queryContext.sql());
35+
log.debug(marker, "SQL executing for pool '{}':\n{}", this.poolName, queryContext.sql());
3636
} else if (log.isInfoEnabled()) {
3737
log.info(marker, "SQL executing for pool '{}'", this.poolName);
3838
}
@@ -50,7 +50,7 @@ public void logQueryEnd(long processingTime, QueryContext queryContext, @Nullabl
5050

5151
if (log.isDebugEnabled()) {
5252
log.debug(marker, "SQL executed for pool '{}':\n{}", this.poolName, queryContext.sql());
53-
} else if(log.isInfoEnabled()) {
53+
} else if (log.isInfoEnabled()) {
5454
log.info(marker, "SQL executed for pool '{}'", this.poolName);
5555
}
5656
}

mkdocs/docs/features/config.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11
# Конфигурации
22

3-
Для конфигурации kora framework использует библиотеку [typesafe config](https://github.com/lightbend/config), которая умеет читать конфигурации в формате [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md).
3+
Kora поддерживает два формата конфигурационных файлов:
44

5-
## Подключение конфигураций
5+
- [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md) с помощью [typesafe config](https://github.com/lightbend/config) через модуль `HoconConfigModule` из `config-hocon`
6+
- YAML через модуль `YamlConfigModule` из `config-yaml`
67

7-
К приложению необходимо добавить модуль `ConfigModule` через наследование.
8-
Он добавит в контекст приложения вычитанный `typesafe config` и компонент, который будет следить за обновлениями внешнего файла конфигурации, если он задан через `-Dconfig.file=some-file.conf`.
8+
В обоих случаях по умолчанию читаются файлы:
9+
10+
- `reference.(yml|conf)` для общих значений
11+
- файл, указанный через `config.file` или `config.resource`
12+
- при отсутствии предыдущего пункта прочитается файл по-умолчанию `application.(yml|conf)`
913

1014
## ConfigSource
1115

12-
Для упрощения создания пользовательских конфигураций следует использовать аннотацию `ConfigSource`.
16+
Для упрощения создания пользовательских конфигураций следует использовать аннотацию `ConfigSource`.
1317

1418
Рассмотрим пример:
1519

1620
```java
21+
1722
@ConfigSource("services.foo")
1823
record FooServiceConfig(String bar, int baz) {}
1924
```
@@ -33,10 +38,26 @@ services {
3338

3439
```java
3540
public final class FooService {
36-
private final FooServiceConfig config;
37-
38-
public FooService(FooServiceConfig config) {
39-
this.config = config;
40-
}
41+
private final FooServiceConfig config;
42+
43+
public FooService(FooServiceConfig config) {
44+
this.config = config;
45+
}
46+
}
47+
```
48+
49+
## Значения по умолчанию
50+
51+
Если есть необходимость использовать в классе значения по умолчанию, то можно воспользоваться таким форматом:
52+
53+
```java
54+
55+
@ConfigSource("services.foo")
56+
interface FooServiceConfig {
57+
String bar();
58+
59+
default int baz() {
60+
return 42;
61+
}
4162
}
4263
```

0 commit comments

Comments
 (0)