;
/** Позволяет создать агрегатную функцию по её имени.
*/
class AggregateFunctionFactory
{
public:
AggregateFunctionFactory();
AggregateFunctionPtr get(const String & name, const DataTypes & argument_types) const;
```
**15.** `namespace`.
Нет необходимости использовать отдельный `namespace` для прикладного кода.
Маленьким библиотекам это тоже не нужно.
Для библиотек среднего и большого размера помещайте всё в `namespace`.
В файле библиотеки `.h` можно использовать `namespace detail`, чтобы скрыть подробности реализации, не нужные прикладному коду.
В файле `.cpp` можно использовать `static` или анонимный `namespace`, чтобы скрыть символы.
Кроме того, `namespace` можно использовать для `enum`, чтобы соответствующие имена не попадали во внешнее `namespace` (но лучше использовать `enum class`).
**16.** Отложенная инициализация.
Если для инициализации требуются аргументы, то обычно не следует писать конструктор по умолчанию.
Если позже потребуется отложить инициализацию, можно добавить конструктор по умолчанию, который будет создавать некорректный объект. Или, если объектов немного, можно использовать `shared_ptr/unique_ptr`.
```cpp theme={null}
Loader(DB::Connection * connection_, const std::string & query, size_t max_block_size_);
/// Для отложенной инициализации
Loader() {}
```
**17.** Виртуальные функции.
Если класс не предназначен для полиморфного использования, делать функции виртуальными не нужно. Это относится и к деструктору.
**18.** Кодировки.
Везде используйте UTF-8. Используйте `std::string` и `char *`. Не используйте `std::wstring` и `wchar_t`.
**19.** Логирование.
См. примеры в коде.
Перед commit удаляйте все бессмысленные и отладочные записи в журнале, а также любые другие виды отладочного вывода.
Следует избегать логирования в циклах, даже на уровне Trace.
Журнал должен оставаться читаемым при любом уровне логирования.
Логирование по большей части следует использовать только в прикладном коде.
Сообщения лога должны быть написаны на английском языке.
Желательно, чтобы журнал был понятен системному администратору.
Не используйте нецензурную лексику в журнале.
Используйте в журнале кодировку UTF-8. В редких случаях в журнале можно использовать символы не из ASCII.
**20.** Ввод-вывод.
Не используйте `iostreams` во внутренних циклах, критичных для производительности приложения (и никогда не используйте `stringstream`).
Вместо этого используйте библиотеку `DB/IO`.
**21.** Дата и время.
См. библиотеку `DateLUT`.
**22.** include.
Всегда используйте `#pragma once` вместо include guards.
**23.** using.
`using namespace` не используется. Можно использовать `using` для чего-то конкретного, но делайте это локально — внутри класса или функции.
**24.** Не используйте для функций `trailing return type`, если в этом нет необходимости.
```cpp theme={null}
auto f() -> void
```
**25.** Объявление и инициализация переменных.
```cpp theme={null}
//правильно
std::string s = "Hello";
std::string s{"Hello"};
//неправильно
auto s = std::string{"Hello"};
```
**26.** Для виртуальных функций в базовом классе пишите `virtual`, а в производных классах вместо `virtual` используйте `override`.
## Неиспользуемые возможности C++
**1.** Виртуальное наследование не используется.
**2.** Конструкции, для которых в современном C++ предусмотрен удобный синтаксический сахар, например:
```cpp theme={null}
// Традиционный способ без синтаксического сахара
template ::value, void>> // SFINAE через std::enable_if, использование ::value
std::pair func(const E & e) // явно указанный тип возвращаемого значения
{
if (elements.count(e)) // проверка вхождения через .count()
{
// ...
}
elements.erase(
std::remove_if(
elements.begin(), elements.end(),
[&](const auto x){
return x == 1;
}),
elements.end()); // идиома remove-erase
return std::make_pair(1, 2); // создание пары через make_pair()
}
// С синтаксическим сахаром (C++14/17/20)
template
requires std::same_v // SFINAE через концепт C++20, использование псевдонима шаблона C++14
auto func(const E & e) // вывод типа возвращаемого значения через auto (C++14)
{
if (elements.contains(e)) // проверка вхождения через .contains в C++20
{
// ...
}
elements.erase_if(
elements,
[&](const auto x){
return x == 1;
}); // std::erase_if в C++20
return {1, 2}; // или: return std::pair(1, 2); // создание пары через список инициализации или инициализацию значением (C++17)
}
```
## Платформа
**1.** Мы пишем код для конкретной платформы.
Но при прочих равных предпочтение отдаётся кроссплатформенному или переносимому коду.
**2.** Язык: C++20 (см. список доступных [возможностей C++20](https://en.cppreference.com/w/cpp/compiler_support#C.2B.2B20_features)).
**3.** Компилятор: `clang`. На момент написания (март 2025 года) код компилируется с помощью clang версии >= 19.
Используется стандартная библиотека (`libc++`).
**4.** ОС: Ubuntu Linux, не старее Precise.
**5.** Код пишется для архитектуры CPU x86\_64.
Набор инструкций CPU — минимально поддерживаемый среди наших серверов. В настоящее время это SSE 4.2.
**6.** Используйте флаги компиляции `-Wall -Wextra -Werror -Weverything` с несколькими исключениями.
**7.** Используйте статическую компоновку со всеми библиотеками, кроме тех, которые трудно подключить статически (см. вывод команды `ldd`).
**8.** Код разрабатывается и отлаживается в release-конфигурации.
## Инструменты
**1.** KDevelop — хорошая IDE.
**2.** Для отладки используйте `gdb`, `valgrind` (`memcheck`), `strace`, `-fsanitize=...` или `tcmalloc_minimal_debug`.
**3.** Для профилирования используйте `Linux Perf`, `valgrind` (`callgrind`) или `strace -cf`.
**4.** Исходники хранятся в Git.
**5.** Для сборки используется `CMake`.
**6.** Программы выпускаются в пакетах `deb`.
**7.** Коммиты в master не должны ломать сборку.
При этом работоспособными считаются только отдельные ревизии.
**8.** Делайте коммиты как можно чаще, даже если код готов лишь частично.
Используйте для этого ветки.
Если ваш код в ветке `master` пока не собирается, исключите его из сборки перед `push`. Вам нужно будет завершить его или удалить в течение нескольких дней.
**9.** Для нетривиальных изменений используйте ветки и публикуйте их на сервере.
**10.** Неиспользуемый код удаляется из репозитория.
## Библиотеки
**1.** Используются стандартная библиотека C++20 (допускаются экспериментальные расширения), а также `boost` и `Poco`.
**2.** Запрещено использовать библиотеки из пакетов операционной системы. Также запрещено использовать предустановленные библиотеки. Все библиотеки должны поставляться в виде исходного кода в каталоге `contrib` и собираться вместе с ClickHouse. Подробности см. в [рекомендациях по добавлению новых сторонних библиотек](/ru/resources/develop-contribute/contribute/contrib#adding-and-maintaining-third-party-libraries).
**3.** Предпочтение всегда отдается библиотекам, которые уже используются.
## Общие рекомендации
**1.** Пишите как можно меньше кода.
**2.** Старайтесь выбирать самое простое решение.
**3.** Не пишите код, пока не поймете, как он должен работать и как будет устроен внутренний цикл.
**4.** В самых простых случаях используйте `using` вместо классов или структур.
**5.** По возможности не пишите конструкторы копирования, операторы присваивания, деструкторы (кроме виртуального, если класс содержит хотя бы одну виртуальную функцию), конструкторы перемещения или операторы присваивания перемещением. Иными словами, функции, сгенерированные компилятором, должны работать корректно. Можно использовать `default`.
**6.** Упрощать код полезно. По возможности уменьшайте его объем.
## Дополнительные рекомендации
**1.** Явно указывать `std::` для типов из `stddef.h`
не рекомендуется. Иными словами, рекомендуем писать `size_t` вместо `std::size_t`, потому что так короче.
Добавлять `std::` допустимо.
**2.** Явно указывать `std::` для функций из стандартной библиотеки C
не рекомендуется. Иными словами, пишите `memcpy` вместо `std::memcpy`.
Причина в том, что существуют похожие нестандартные функции, например `memmem`. Мы действительно иногда используем такие функции. В `namespace std` их нет.
Если везде писать `std::memcpy` вместо `memcpy`, то `memmem` без `std::` будет выглядеть странно.
Тем не менее, при желании вы можете использовать `std::`.
**3.** Использование функций из C, когда такие же доступны в стандартной библиотеке C++.
Это допустимо, если так эффективнее.
Например, используйте `memcpy` вместо `std::copy` для копирования больших фрагментов памяти.
**4.** Многострочные аргументы функции.
Допустим любой из следующих стилей переноса:
```cpp theme={null}
function(
T1 x1,
T2 x2)
```
```cpp theme={null}
function(
size_t left, size_t right,
const & RangesInDataParts ranges,
size_t limit)
```
```cpp theme={null}
function(size_t left, size_t right,
const & RangesInDataParts ranges,
size_t limit)
```
```cpp theme={null}
function(size_t left, size_t right,
const & RangesInDataParts ranges,
size_t limit)
```
```cpp theme={null}
function(
size_t left,
size_t right,
const & RangesInDataParts ranges,
size_t limit)
```