Введение в osframe

Этот проект представляет собой базовый фреймворк для разработки серверной части, основанный на Spring MVC + Spring + Hibernate. Для фронтенда используется AngularJS + Sea.js + Bootstrap. Базовый фреймворк включает модули управления пользователями и правами доступа, а также простую домашнюю страницу портала, которая может использоваться для быстрого создания проектов.

Путь к запуску приложения: http://localhost:9080/, имя пользователя: admin, пароль: 1

1. Предварительный просмотр

Домашняя страница

Управление пользователями

Управление правами доступа

Список DEMO

Создание или редактирование DEMO

Просмотр эффекта DEMO

2. Поддерживаемые браузеры

Проект поддерживает браузеры Internet Explorer 9 и выше, Google Chrome, Safari и другие популярные браузеры. Обратите внимание, что браузеры ниже версии Internet Explorer 8 не поддерживаются.

3. Локальное запуск проектаОткройте dataSource.properties в папке resource внутри модуля web-view, измените данные подключения к базе данных, имя пользователя и пароль. Запустите приложение с помощью Maven Jetty плагина.После успешного запуска переходите по адресу: http://localhost:9080/, имя пользователя: admin, пароль: 1

4. Направления разработки

Создайте свой модуль, следуя примеру DEMO-модуля. Сначала изучите структуру каталогов DEMO-модуля:

Компактная структура пакетов начинается с com.os.osframe, затем следует пакет модуля, который вы можете определить самостоятельно. Под ними находятся уровни кода: web, service, domain, dao.

Файлы i18n в папке ресурсов используются для международной локализации, enums.properties — это файл определения системных перечислений, osDemo-beans.xml — конфигурационный файл Spring для модуля. Обратите внимание, что аннотации сканирования не требуют специальной конфигурации здесь; они автоматически сканируются по умолчанию, а эта область предназначена для специальных случаев.

5. Разработка согласно стандартам* 1) Путь к пакетам должен начинаться с com.os.osframe, далее следует путь к пакету модуля, который можно определить самостоятельно;

• 2. Контроллер главной страницы модуля должен наследовать BaseIndexController, контроллер обычного сущностного объекта должен наследовать BaseController<сущность>.
• 3. Энтитетные классы наследуются от BaseDomain и через аннотации Hibernate определяются имя таблицы и маппинг полей.
• 4. Классы слоя DAO наследуются от BaseDaoImpl<энтитетный класс>, а интерфейсы — от IBaseDao<энтитетный класс>.
• 5. Классы слоя SERVICE наследуются от BaseServiceImpl<энтитетный класс>, а интерфейсы — от IBaseService<энтитетный класс>.
• 6. Управление правами осуществляется путём добавления аннотации @RequiresClassAuth в контроллер уровня web.
• 7. По умолчанию модуль имеет права доступа, включающие административные права, права по умолчанию, права добавления, просмотра, редактирования и удаления. Эти права также определяются в файлах ресурсов i18n с указанием имени name и описания info. После добавления новых прав в контроллер уровня web они могут быть автоматически импортированы в систему управления правами при нажатии кнопки "Импорт". Пример конфигурации демонстрационного модуля приведён ниже:

ROLE_OS_DEMO_ADMIN.name = Тестовый модуль_Административные права
ROLE_OS_DEMO_ADMIN.info = Владелец этих прав может управлять всеми функциями тестового модуля
ROLE_OS_DEMO_DEFAULT.name = Тестовый модуль_Права по умолчанию
``````markdown
info = Владелец этих прав может использовать тестовый модуль  
ROLE_OS_DEMO_ADD.name = Тестовый модуль: право добавления  
ROLE_OS_DEMO_DELETE.name = Тестовый модуль: право удаления  
ROLE_OS_DEMO_LOOK.name = Тестовый модуль: право просмотра  
ROLE_OS_DEMO_EDIT.name = Тестовый модуль: право редактирования  

ROLE_OS_DEMO_ADD.info = Владелец этих прав может добавлять записи в модуль управления пользователями  
ROLE_OS_DEMO_DELETE.info = Владелец этих прав может удалять записи в тестовом модуле  
ROLE_OS_DEMO_LOOK.info = Владелец этих прав может просматривать записи в тестовом модуле  
ROLE_OS_DEMO_EDIT.info = Владелец этих прав может редактировать записи в тестовом модуле  

Значения энумов должны быть определены в файле `enums.properties`, а их названия — в `i18n`:

```properties
enumsDemo.simple = Простой  
enumsDemo.middle = Средний  
enumsDemo.difficulty = Сложный  

330710190 (Группа технического взаимодействия OSFrame)
Приглашаем всех присоединиться и вместе обсуждать вопросы использования.

#6. Документация для разработчиков
Документация OSFrame: [http://my.oschina.net/u/2351717/blog?catalog=3601774&temp=1467162209702](http://my.oschina.net/u/2351717/blog?catalog=3601774&temp=1467162209702)

#7. Инструкция по запуску проекта

1. Модуль install
   В корневом проекте osframe в среде IDEA Maven Projects выберите install, чтобы установить все модули.
   Также можно установить каждый модуль отдельно, следуя зависимостям: util, framework, users, auth, login, taglib.
2. Изменение конфигурации базы данных
   В модуле web-view в папке src/main/resources измените dataSource.properties для локальной конфигурации базы данных.
   hibernate.driverClassName=com.mysql.jdbc.Driver
   hibernate.dialect=org.hibernate.dialect.MySQLDialect

hibernate.url=jdbc:mysql://localhost:3306/spring3?useUnicode=true&characterEncoding=UTF-8  
hibernate.username=root  
hibernate.password=1  

3) Запуск проекта  
   В IDEA запустите модуль web-view в разделе Maven projects -> plugins/jetty.

4) Авторизация  
   Введите в браузере http://localhost:9080/, чтобы открыть страницу авторизации.  
   Логин: admin  
   Пароль: 1

#8. Добавление модуля автоматического генератора кода web-autocode

   Отдельно запустите модуль web-autocode, откройте http://localhost:8888/os/index.html, чтобы получить доступ к интерфейсу проектирования модулей и структуры таблиц.  
   Сначала необходимо настроить модуль; после этого настройка будет отображаться ниже списка таблиц слева. Нажмите на модуль, затем выполните настройку таблиц.2) Автоматическое создание кода  
   После завершения конфигурации таблиц в модуле, нажмите кнопку "Создать код" в верхнем правом углу таблицы, чтобы сгенерировать все необходимые коды для серверной части.

3) Онлайн-скачивание кода  
   После создания кода, нажмите кнопку "Загрузить" в верхнем правом углу таблицы, чтобы скачать ранее сгенерированный код. Формат скачиваемого файла — zip; распакуйте его, и вы получите путь к модулю и различные уровни кода проекта.  
   Скопируйте код в соответствующие места внутри модуля, запустите проект, и он будет работать.