Должен ли я использовать один или несколько файлов конфигурации для генерации кода - PullRequest
0 голосов
/ 30 октября 2010

У меня есть сценарий php, который генерирует классы-оболочки php и javascript, которые обрабатывают сортировку json на основе файла конфигурации.

Мой первоначальный план состоял в том, чтобы иметь один файл конфигурации, который генерирует все классы, используемые приложением. Однако руководитель группы предложил мне использовать отдельный файл для каждой функции, чтобы избежать создания гигантского файла конфигурации, и создать каталог, определяющий объекты json, которые используются несколькими функциями

Я сравнил это с Struts-config.xml, где все определения находятся в одном файле. Другим примером является словарь данных, который используется для генерации классов доступа к БД и SQL для генерации этих таблиц; в предыдущих работах всегда был один файл, в котором определялись все таблицы БД, поэтому я даже не задумывался над этим, поскольку к этому я привык.

Он сравнил его с idl (это очень похоже на idl), и мы не храним все определения idl в одном месте.

Так что я бы хотел аргументы за и против использования одного файла. Вот некоторые из них:

Один файл

  • Хорошо

    • Вы можете видеть все объекты json в одном месте (это ядро ​​нашего веб-API и используется для документирования вызовов Ajax на сервере)
    • Вам нужен только один make-файл (или цель муравья)
  • Bad

    • Файл может быть трудно редактировать, когда он становится слишком большим

Несколько файлов

  • Хороший
    • JSON, используемый только для одной функции, не предоставляется (приватно для проекта)
  • Плохой
    • Как только объект JSON используется двумя функциями, его необходимо переместить в другой файл

Любая обратная связь приветствуется, и, пожалуйста, попросите уточнить, хотите ли вы присоединиться, но не совсем уверены, о чем я говорю.

Ответы [ 2 ]

0 голосов
/ 04 ноября 2010

Чтобы отделить конфигурацию от кода, я создал папку вне веб-папки (htdocs), содержащую файлы конфигурации, и они имитируют структуру папок в htdocs. Файлы, скомпилированные из файлов конфигурации, затем перемещаются в место, где они будут использоваться. Поэтому я думаю, что сделал всех счастливыми. Все файлы конфигурации находятся в отдельной папке, но они по-прежнему организованы по функциям. Поэтому понятно, что все файлы конфигурации находятся в одном месте, но при этом все файлы конфигурации группируются по функциям. Извините за запутанный вопрос ...

0 голосов
/ 30 октября 2010

Программирование или нет Я думаю, что нижеприведенные принципы являются хорошими предложениями. Так что примените эти два к вашей ситуации, и вы ответите себе; -)

Принцип единой ответственности Сплоченность: группируйте связанные вещи вместе

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...