3.4. What you need, where you need it (WYNWYN): Контекстозависимость и Связанность кода

То, что нужно, там, где нужно (ТЧНТГН) (англ) What you need, where you need it (WYNWYN)

“Никто не понимает DRY” или “Контекстозависимость”

Один и тот же код, в разных контекстах является разным.

Что такое контекст

1. Роль пользователя, который стригерил бизнес-логику (”заказ создает администратор / клиент / партнер”)

2. Применяется ли этот бизнес-процесс к одной (”удалить пользователя по id”) или ко множеству сущностей (”удалить пользователей, который не появлялись более года”)

3. Тип устройства от которого мы парсим данные (”парсим данные с кофемашины / вендингового автомата”)

4. etc.

Если вы хотите, чтобы ваш код был достаточно гибким , всегда думайте о том, в каком контексте вы его пишите и стоит ли переиспользовать его в другом контексте.

Связанность кода

// common/index.ts
// Вот эта переиспользуемая функция, которая повышает связанность кода
const someCommonFunction = (foo: string, bar: Record<any, any>) => {
	// ...
}

// first/index.ts
import {someCommonFunction} from "common/index.ts"

const first = () => {
	// ...
	someCommonFunction(foo, bar)
	// ...
}

// second/index.ts
import {someCommonFunction} from "common/index.ts"

const second = () => {
	// ...
	someCommonFunction(foo, bar)
	// ...
}

// common/index.ts
// Например, нам теперь в первом случае надо еще добавлять postfix.
// Сделаем это самым хреновым способом: добавим флаг
const someCommonFunction = (foo: string, bar: Record<any, any>, postfixNeeded: boolean = false) => {
	// ...
}

// first/index.ts
import {someCommonFunction} from "common/index.ts"

const first = () => {
	// ...
	someCommonFunction(foo, bar, true)
	// ...
}

// second/index.ts
import {someCommonFunction} from "common/index.ts"

const second = () => {
	// ...
	someCommonFunction(foo, bar)
	// ...
}

// common/index.ts
const someCommonFunction = (foo: string, bar: Record<any, any>) => {
	// ...
}

const someCommonLogicWithPrefix = (foo: string, bar: Record<any, any>) => {
	// ...
	someCommonFunction(foo, bar)
	// ...
}

// first/index.ts
import {someCommonLogicWithPrefix} from "common/index.ts"

const first = () => {
	// ...
	someCommonLogicWithPrefix(foo, bar)
	// ...
}

// second/index.ts
import {someCommonFunction} from "common/index.ts"

const second = () => {
	// ...
	someCommonFunction(foo, bar)
	// ...
}

// common/index.ts
const someCommonFunction = (foo: string, bar: Record<any, any>) => {
	// ...
}

// first/index.ts
import {someCommonLogic} from "common/index.ts"

const someCommonLogicWithPrefix = (foo: string, bar: Record<any, any>) => {
	// ...
	someCommonFunction(foo, bar)
	// ...
}

const first = () => {
	// ...
	someCommonLogicWithPrefix(foo, bar)
	// ...
}

// second/index.ts
import {someCommonFunction} from "common/index.ts"

const second = () => {
	// ...
	someCommonFunction(foo, bar)
	// ...
}

// first/index.ts
const someCommonFunction = (foo: string, bar: Record<any, any>) => {
	// ...
}

const first = () => {
	// ...
	someCommonLogic(foo, bar)
	// ...
}

// second/index.ts

const someCommonFunction = (foo: string, bar: Record<any, any>) => {
	// ...
}

const second = () => {
	// ...
	someCommonFunction(foo, bar)
	// ...
}

ООП поощеряет нарушение WYNWYN

class First {
	someLogic() {
		// ...
		// И вот по-середине кода какая-то переиспользуемая логика
		// ...
	}
}

class Second {
	someLogic() {
		// ...
		// И вот по-середине кода какая-то переиспользуемая логика
		// ...
	}
}

class CommonLogicService {
	commonLogic() {
		// ...
	}	
}

class First {
	constructor(private commonLogicService: CommonLogicService) {}

	someLogic() {
		// ...
		this.commonLogicService.commonLogic()
		// ...
	}
}

class Second {
	constructor(private commonLogicService: CommonLogicService) {}

	someLogic() {
		// ...
		this.commonLogicService.commonLogic()
		// ...
	}
}

class First {
	// Опять же, вместо выноса в отдельный класс, мы просто создадим
	// приватный метод и сделаем его дубликат в классе Second
	private commonLogic() {
		// ...
	}

	someLogic() {
		// ...
		this.commonLogic()
		// ...
	}
}

class Second {
	private commonLogic() {
		// ...
	}

	someLogic() {
		// ...
		this.commonLogic()
		// ...
	}
}

// Например
class User {
	private id: string
	private email: string
	private	age: number

	changeEmail() {
		// ...
	}

	changeAge() {
		// ...
	}
}

// Например
class User {
	private id: string
	private email: string
	private	age: number

	changeEmail() {
		// ...
	}

	changeEmailByAdmin() {
		// ...
	}

	changeAge() {
		// ...
	}
}

// Например
class User {
	private id: string
	private email: string
	private	age: number

	private changeEmailCommonLogic() {
		// ...
	}

	changeEmail() {
		// ...
	}

	changeEmailByPartner() {
		// ...
	}

	changeEmailByAdmin() {
		// ...
	}

	private changeAgeCommonLogic() {
		// ...
	}

	changeAge() {
		// ...
	}

	changeAgeByAdmin() {
		// ...
	}

	changeAgeByPartner() {
		// ...
	}
}

Лайфхаки

i. Правило 3-х

Я выношу код для переиспользования только в том случае, если повторил его 3 и более раз

ii. Аксиомы

1. Математические формулы и типы данных (вектор и функция его сложения, формула вычисления скорости падающего предмета, etc.)

2. Интерфейс доступа к сторонним сервисам, то есть все, что представляет является SDK / библиотекой API.

3. Формулы, заданные ГОСТ-ами (например, по вычислению минимально требующегося индекса качества материала, на базе анализа его содержания)

4. Специфические правила вашей бизнес-области (например, мы не можем отправлять на наши устройства числа больше 8bit, поэтому функции создания или валидации этих чисел можно вынести в общую область)

5. Описание структуры таблиц вашей базы данных (если у сервиса есть доступ к этой базе и к этим таблицам, значит он имеет право просто видеть какие там есть структуры данных)

Заключение