http://wiki.dote.ru/api.php?action=feedcontributions&feedformat=atom&user=Asko 2026-06-21T05:02:38Z Вклад участника MediaWiki 1.23.3 http://wiki.dote.ru/index.php/BeanExplorer5 2016-05-10T11:06:27Z

<p>Asko: /* Backend */</p> <hr /> <div>&lt;big&gt;Это основная статья о BeanExplorer5.&lt;/big&gt;<br /> <br /> Поскольку эта основная статья недописана, остальная её часть для тех, кто будет дорабатывать BeanExplorer5, а не использовать.<br /> <br /> ==Концепции и технологии==<br /> <br /> Основные технологии, которые мы используем - это Java, Java Servlet, OSGi, React, SystemJS, ES2015 через Babel.<br /> <br /> ===Frontend===<br /> <br /> Основные frontend компоненты написаны на React, но могут быть написаны на чём угодно. Поскольку React - это лишь &quot;V&quot; из MVC, то часть функционала полноценного frontend framework было необходимо реализовать, и этот функционал находится в be5/be5-frontend/src/scripts/be5.js (или просто be5 - далее буду писать имена скриптов кратко). Это покрывает функционал routing, requests, frontend localization. Также полезный базовый функционал находится в be5/bus, be5/createStore, be5/createSimpleStore, be5/ext.<br /> * bus - сообщения (брокер из паттерна pub/sub); например, bus.fire('DocumentChange', value), bus.listen('DocumentChange', value =&gt; ...);<br /> * ext - расширения;<br /> * createStore - создание store для управления данными на frontend; позволяет подписаться на его изменения;<br /> * createSimpleStore - создание store, полным состоянием которого является результат GET запроса.<br /> <br /> Необходимые части frontend подгружаются динамически с помощью SystemJS.<br /> <br /> JSX+ES2015 скрипты компилируются с помощью Babel при сборке проекта.<br /> <br /> Нерешённые проблемы:<br /> * frontend подготовлен, но не переведён на [https://github.com/reactjs/react-redux redux], а это необходимо для упрощения работы с React компонентами (без redux или Flux бывает довольно нетривиально управлять состоянием React компонентов);<br /> * be5.js требует разделения на небольшие части, также, как выделены bus и ext;<br /> * невозможно отказаться от компиляции ES2015, даже если она будет поддерживаться всеми браузерами. SystemJS проверяет наличие ES2015 синтаксиса в скриптах, и в случае его наличия пытается использовать транслятор в браузере, даже если явно указано, что транслятора нет.<br /> <br /> Tips на будущее:<br /> * используйте [https://github.com/reactjs/react-redux redux], [https://facebook.github.io/react/docs/two-way-binding-helpers.html React two-way binding], [https://github.com/JedWatson/classnames React classNames].<br /> <br /> ===Backend===<br /> <br /> Основные части API находятся в com.beanexplorer.enterprise.api. Проще всего начать знакомство с BE5, посмотрев на содержимое этого пакета и его подпакетов. В com.beanexplorer.enterprise.api.experimental.v1 хранятся маленькие полезности. Если они становятся не экспериментальными, а доказавшими полезность, можно переносить их в другие подпакеты api. v1 в названии пакета необходимо для поддержки разного API для одинакового функционала, если невозможно быстро отрефакторить код с экспериментальным функционалом или если хочется проверить, какой подход окажется полезнее.<br /> <br /> Сердце всего BE5 - это ServiceProvider. ServiceProvider доступен компонентам, а в конструкторы сервисов инжектируются другие сервисы или сам ServiceProvider.<br /> <br /> Good practices:<br /> * Разделяем модельные элементы на бины без логики, сервисы и репозитории.<br /> * Презентационный код пишется в компонентах. Если в компоненте много строчек кода, то что-то пошло не так.<br /> <br /> Нерешённые проблемы:<br /> * При написании operation почти любая строчка кода приводит к увеличению зависимости от наличия метаданных в БД, а также ухудшению возможности что либо протестировать, равно как и невозможности переиспользовать написанный код. Необходимо новое API для операций, полагающееся на сервисы - содержимого com.beanexplorer.enterprise.api.experimental и com.beanexplorer.enterprise.api.experimental.v1 недостаточно.<br /> * Нет предусмотренного сетапа для тестирования.<br /> * Нет API для запросов из БД, которое покрывает все возможные SQL запросы.<br /> * Мы не избавились от метаданных в базе данных, поскольку BeanExplorer5 использует legacy код, который полагается на наличие метаданных в базе данных.<br /> * Нет стандартного способа взять запрос из Query (той, что определена в YAML) и запустить его. Дело в том, что концептуально сейчас Query - это запросы, которые используются как запросы для таблиц, которые может увидеть пользователь. Такие запросы помечаются набором ролей, обладатели которых могут запускать запросы. Однако бывает необходимость описать запрос на BE-SQL и запустить его из Java. На мой взгляд не только роли должны игнорироваться, но и вообще такие запросы должны либо где-то в другом месте лежать (например, namedQueries.yaml), либо быть приписанными к Entity и не находиться в разделе queries, а, например, находиться в разделе &quot;systemQueries&quot; (причём поскольку это новые запросы, они никогда не должны попадать в БД, а быть только в in-memory meta/project; сейчас запустить обычную Query через BE-SQL игнорируя роли можно так: executorService.createExecutor(meta.getQueryIgnoringRoles(&quot;entityName&quot;, &quot;queryName&quot;), request, serviceProvider).execute()). Кстати, теперь можно убрать ServiceProvider из последнего аргумента, польскольку он может инжектироваться в ExecutorServiceImpl.<br /> <br /> Tips на будущее:<br /> * Можно ресширить функционал ServiceProvider добавлением способности обрабатывать аннотированные поля сервисов - это избавит от проблем обхода циклических зависимостей сервисов и написания boilderplate в конструкторах. Также возможно попробовать сэмулировать поведение из Spring Core или Google Guice - это бы позволило просто перйти на них при возможности (см. следующее).<br /> * Можно даже использовать Google Guice или переиспользовать Spring Core, если найдётся хороший способ регистрации сервисов из разных OSGi модулей (сам BE5 и BE5 приложение - в разных OSGi модулях).<br /> * В идеальном случае было бы хорошо не писать репозитории, да и сервисы для запросов - для этого есть Hibernate, реализации JPA и другие ORM. А ещё лучше - попробовать переиспользовать Spring Data (объявлять интерфейсы с методами, описывающими запрос, без необходимости писать сам код запроса - как personRepository.findByEmailAndActive(&quot;email&quot;, true) - вызов метода из интерфейса, реализацию которого подкладывает Spring).<br /> * Или хотя бы доделать SQL builder (SqlBuilder) и SQL Service (SqlService), потому что они сейчас не позволяют делать запросы с LEFT JOIN и WITH RECURSIVE.<br /> * В таком случае было бы хорошо реализовывать код репозиториев с использованием одного универсального парсера из ResultSet в бины (при этом он должен работать по принципу fail-fast, а не как Dynamic.assign(Object bean, DynamicPropertySet dynamicProperties), который игнорирует все ошибки).<br /> <br /> ==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> ==BeanExplorer5 API==<br /> См. [[BeanExplorer5 API|BeanExplorer5 API]]<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5 2016-05-10T10:52:07Z

<p>Asko: /* Backend */</p> <hr /> <div>&lt;big&gt;Это основная статья о BeanExplorer5.&lt;/big&gt;<br /> <br /> Поскольку эта основная статья недописана, остальная её часть для тех, кто будет дорабатывать BeanExplorer5, а не использовать.<br /> <br /> ==Концепции и технологии==<br /> <br /> Основные технологии, которые мы используем - это Java, Java Servlet, OSGi, React, SystemJS, ES2015 через Babel.<br /> <br /> ===Frontend===<br /> <br /> Основные frontend компоненты написаны на React, но могут быть написаны на чём угодно. Поскольку React - это лишь &quot;V&quot; из MVC, то часть функционала полноценного frontend framework было необходимо реализовать, и этот функционал находится в be5/be5-frontend/src/scripts/be5.js (или просто be5 - далее буду писать имена скриптов кратко). Это покрывает функционал routing, requests, frontend localization. Также полезный базовый функционал находится в be5/bus, be5/createStore, be5/createSimpleStore, be5/ext.<br /> * bus - сообщения (брокер из паттерна pub/sub); например, bus.fire('DocumentChange', value), bus.listen('DocumentChange', value =&gt; ...);<br /> * ext - расширения;<br /> * createStore - создание store для управления данными на frontend; позволяет подписаться на его изменения;<br /> * createSimpleStore - создание store, полным состоянием которого является результат GET запроса.<br /> <br /> Необходимые части frontend подгружаются динамически с помощью SystemJS.<br /> <br /> JSX+ES2015 скрипты компилируются с помощью Babel при сборке проекта.<br /> <br /> Нерешённые проблемы:<br /> * frontend подготовлен, но не переведён на [https://github.com/reactjs/react-redux redux], а это необходимо для упрощения работы с React компонентами (без redux или Flux бывает довольно нетривиально управлять состоянием React компонентов);<br /> * be5.js требует разделения на небольшие части, также, как выделены bus и ext;<br /> * невозможно отказаться от компиляции ES2015, даже если она будет поддерживаться всеми браузерами. SystemJS проверяет наличие ES2015 синтаксиса в скриптах, и в случае его наличия пытается использовать транслятор в браузере, даже если явно указано, что транслятора нет.<br /> <br /> Tips на будущее:<br /> * используйте [https://github.com/reactjs/react-redux redux], [https://facebook.github.io/react/docs/two-way-binding-helpers.html React two-way binding], [https://github.com/JedWatson/classnames React classNames].<br /> <br /> ===Backend===<br /> <br /> Основные части API находятся в com.beanexplorer.enterprise.api. Проще всего начать знакомство с BE5, посмотрев на содержимое этого пакета и его подпакетов. В com.beanexplorer.enterprise.api.experimental.v1 хранятся маленькие полезности. Если они становятся не экспериментальными, а доказавшими полезность, можно переносить их в другие подпакеты api. v1 в названии пакета необходимо для поддержки разного API для одинакового функционала, если невозможно быстро отрефакторить код с экспериментальным функционалом или если хочется проверить, какой подход окажется полезнее.<br /> <br /> Сердце всего BE5 - это ServiceProvider. ServiceProvider доступен компонентам, а в конструкторы сервисов инжектируются другие сервисы или сам ServiceProvider.<br /> <br /> Good practices:<br /> * Разделяем модельные элементы на бины без логики, сервисы и репозитории.<br /> * Презентационный код пишется в компонентах. Если в компоненте много строчек кода, то что-то пошло не так.<br /> <br /> Нерешённые проблемы:<br /> * При написании operation почти любая строчка кода приводит к увеличению зависимости от наличия метаданных в БД, а также ухудшению возможности что либо протестировать, равно как и невозможности переиспользовать написанный код. Необходимо новое API для операций, полагающееся на сервисы - содержимого com.beanexplorer.enterprise.api.experimental и com.beanexplorer.enterprise.api.experimental.v1 недостаточно.<br /> * Нет предусмотренного сетапа для тестирования.<br /> * Нет API для запросов из БД, которое покрывает все возможные SQL запросы.<br /> * Мы не избавились от метаданных в базе данных, поскольку BeanExplorer5 использует legacy код, который полагается на наличие метаданных в базе данных.<br /> <br /> Tips на будущее:<br /> * Можно ресширить функционал ServiceProvider добавлением способности обрабатывать аннотированные поля сервисов - это избавит от проблем обхода циклических зависимостей сервисов и написания boilderplate в конструкторах. Также возможно попробовать сэмулировать поведение из Spring Core или Google Guice - это бы позволило просто перйти на них при возможности (см. следующее).<br /> * Можно даже использовать Google Guice или переиспользовать Spring Core, если найдётся хороший способ регистрации сервисов из разных OSGi модулей (сам BE5 и BE5 приложение - в разных OSGi модулях).<br /> * В идеальном случае было бы хорошо не писать репозитории, да и сервисы для запросов - для этого есть Hibernate, реализации JPA и другие ORM. А ещё лучше - попробовать переиспользовать Spring Data (объявлять интерфейсы с методами, описывающими запрос, без необходимости писать сам код запроса - как personRepository.findByEmailAndActive(&quot;email&quot;, true) - вызов метода из интерфейса, реализацию которого подкладывает Spring).<br /> * Или хотя бы доделать SQL builder (SqlBuilder) и SQL Service (SqlService), потому что они сейчас не позволяют делать запросы с LEFT JOIN и WITH RECURSIVE.<br /> * В таком случае было бы хорошо реализовывать код репозиториев с использованием одного универсального парсера из ResultSet в бины (при этом он должен работать по принципу fail-fast, а не как Dynamic.assign(Object bean, DynamicPropertySet dynamicProperties), который игнорирует все ошибки).<br /> <br /> ==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> ==BeanExplorer5 API==<br /> См. [[BeanExplorer5 API|BeanExplorer5 API]]<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5 2016-05-10T10:47:32Z

<p>Asko: /* Frontend */</p> <hr /> <div>&lt;big&gt;Это основная статья о BeanExplorer5.&lt;/big&gt;<br /> <br /> Поскольку эта основная статья недописана, остальная её часть для тех, кто будет дорабатывать BeanExplorer5, а не использовать.<br /> <br /> ==Концепции и технологии==<br /> <br /> Основные технологии, которые мы используем - это Java, Java Servlet, OSGi, React, SystemJS, ES2015 через Babel.<br /> <br /> ===Frontend===<br /> <br /> Основные frontend компоненты написаны на React, но могут быть написаны на чём угодно. Поскольку React - это лишь &quot;V&quot; из MVC, то часть функционала полноценного frontend framework было необходимо реализовать, и этот функционал находится в be5/be5-frontend/src/scripts/be5.js (или просто be5 - далее буду писать имена скриптов кратко). Это покрывает функционал routing, requests, frontend localization. Также полезный базовый функционал находится в be5/bus, be5/createStore, be5/createSimpleStore, be5/ext.<br /> * bus - сообщения (брокер из паттерна pub/sub); например, bus.fire('DocumentChange', value), bus.listen('DocumentChange', value =&gt; ...);<br /> * ext - расширения;<br /> * createStore - создание store для управления данными на frontend; позволяет подписаться на его изменения;<br /> * createSimpleStore - создание store, полным состоянием которого является результат GET запроса.<br /> <br /> Необходимые части frontend подгружаются динамически с помощью SystemJS.<br /> <br /> JSX+ES2015 скрипты компилируются с помощью Babel при сборке проекта.<br /> <br /> Нерешённые проблемы:<br /> * frontend подготовлен, но не переведён на [https://github.com/reactjs/react-redux redux], а это необходимо для упрощения работы с React компонентами (без redux или Flux бывает довольно нетривиально управлять состоянием React компонентов);<br /> * be5.js требует разделения на небольшие части, также, как выделены bus и ext;<br /> * невозможно отказаться от компиляции ES2015, даже если она будет поддерживаться всеми браузерами. SystemJS проверяет наличие ES2015 синтаксиса в скриптах, и в случае его наличия пытается использовать транслятор в браузере, даже если явно указано, что транслятора нет.<br /> <br /> Tips на будущее:<br /> * используйте [https://github.com/reactjs/react-redux redux], [https://facebook.github.io/react/docs/two-way-binding-helpers.html React two-way binding], [https://github.com/JedWatson/classnames React classNames].<br /> <br /> ===Backend===<br /> <br /> Основные части API находятся в com.beanexplorer.enterprise.api. Проще всего начать знакомство с BE5, посмотрев на содержимое этого пакета и его подпакетов. В com.beanexplorer.enterprise.api.experimental.v1 хранятся маленькие полезности. Если они становятся не экспериментальными, а доказавшими полезность, можно переносить их в другие подпакеты api. v1 в названии пакета необходимо для поддержки разного API для одинакового функционала, если невозможно быстро отрефакторить код с экспериментальным функционалом или если хочется проверить, какой подход окажется полезнее.<br /> <br /> Сердце всего BE5 - это ServiceProvider. ServiceProvider доступен компонентам, а в конструкторы сервисов инжектируются другие сервисы или сам ServiceProvider.<br /> <br /> Good practices:<br /> * Разделяем модельные элементы на бины без логики, сервисы и репозитории.<br /> * Презентационный код пишется в компонентах. Если в компоненте много строчек кода, то что-то пошло не так.<br /> <br /> Нерешённые проблемы:<br /> * При написании operation почти любая строчка кода приводит к увеличению зависимости от наличия метаданных в БД, а также ухудшению возможности что либо протестировать, равно как и невозможности переиспользовать написанный код. Необходимо новое API для операций, полагающееся на сервисы - содержимого com.beanexplorer.enterprise.api.experimental и com.beanexplorer.enterprise.api.experimental.v1 недостаточно.<br /> * Нет предусмотренного сетапа для тестирования.<br /> * Нет API для запросов из БД, которое покрывает все возможные SQL запросы.<br /> * Мы не избавились от метаданных в базе данных, поскольку BeanExplorer5 использует legacy код, который полагается на наличие метаданных в базе данных.<br /> <br /> Tips на будущее:<br /> * Можно ресширить функционал ServiceProvider добавлением способности обрабатывать аннотированные поля сервисов - это избавит от проблем обхода циклических зависимостей сервисов и написания boilderplate в конструкторах. Также возможно попробовать сэмулировать поведение из Spring Core или Google Guice - это бы позволило просто перйти на них при возможности (см. следующее).<br /> * Можно даже использовать Google Guice или переиспользовать Spring Core, если найдётся хороший способ регистрации сервисов из разных OSGi модулей (сам BE5 и BE5 приложение - в разных OSGi модулях).<br /> * В идеальном случае было бы хорошо не писать репозитории, да и сервисы для запросов - для этого есть Hibernate, реализации JPA и другие ORM. А ещё лучше - попробовать переиспользовать Spring Data (объявлять интерфейсы с методами, описывающими запрос, без необходимости писать сам код запроса - как personRepository.findByEmailAndActive(&quot;email&quot;, true) - вызов метода из интерфейса, реализацию которого подкладывает Spring).<br /> * Или хотя бы доделать SQL builder (SqlBuilder) и SQL Service (SqlService), потому что они сейчас не позволяют делать запросы с LEFT JOIN и WITH RECURSIVE.<br /> <br /> ==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> ==BeanExplorer5 API==<br /> См. [[BeanExplorer5 API|BeanExplorer5 API]]<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5 2016-05-10T10:45:46Z

<p>Asko: /* Концепции */</p> <hr /> <div>&lt;big&gt;Это основная статья о BeanExplorer5.&lt;/big&gt;<br /> <br /> Поскольку эта основная статья недописана, остальная её часть для тех, кто будет дорабатывать BeanExplorer5, а не использовать.<br /> <br /> ==Концепции и технологии==<br /> <br /> Основные технологии, которые мы используем - это Java, Java Servlet, OSGi, React, SystemJS, ES2015 через Babel.<br /> <br /> ===Frontend===<br /> <br /> Основные frontend компоненты написаны на React, но могут быть написаны на чём угодно. Поскольку React - это лишь &quot;V&quot; из MVC, то часть функционала полноценного frontend framework было необходимо реализовать, и этот функционал находится в be5/be5-frontend/src/scripts/be5.js (или просто be5 - далее буду писать имена скриптов кратко). Это покрывает функционал routing, requests, frontend localization. Также полезный базовый функционал находится в be5/bus, be5/createStore, be5/createSimpleStore, be5/ext.<br /> * bus - сообщения (брокер из паттерна pub/sub); например, bus.fire('DocumentChange', value), bus.listen('DocumentChange', value =&gt; ...);<br /> * ext - расширения;<br /> * createStore - создание store для управления данными на frontend; позволяет подписаться на его изменения;<br /> * createSimpleStore - создание store, полным состоянием которого является результат GET запроса.<br /> <br /> Необходимые части frontend подгружаются динамически с помощью SystemJS.<br /> <br /> JSX+ES2015 скрипты компилируются с помощью Babel при сборке проекта.<br /> <br /> Нерешённые проблемы:<br /> * frontend подготовлен, но не переведён на [https://github.com/reactjs/react-redux redux], а это необходимо для упрощения работы с React компонентами (без redux или Flux бывает довольно нетривиально управлять состоянием React компонентов);<br /> * be5.js требует разделения на небольшие части, также, как выделены bus и ext;<br /> * невозможно отказаться от компиляции ES2015, даже если она будет поддерживаться всеми браузерами. SystemJS проверяет наличие ES2015 синтаксиса в скриптах, и в случае его наличия потается использовать транслятор в браузере, даже если явно указано, что транслятора нет<br /> <br /> Tips на будущее:<br /> * используйте [https://github.com/reactjs/react-redux redux], [https://facebook.github.io/react/docs/two-way-binding-helpers.html React two-way binding], [https://github.com/JedWatson/classnames React classNames].<br /> <br /> ===Backend===<br /> <br /> Основные части API находятся в com.beanexplorer.enterprise.api. Проще всего начать знакомство с BE5, посмотрев на содержимое этого пакета и его подпакетов. В com.beanexplorer.enterprise.api.experimental.v1 хранятся маленькие полезности. Если они становятся не экспериментальными, а доказавшими полезность, можно переносить их в другие подпакеты api. v1 в названии пакета необходимо для поддержки разного API для одинакового функционала, если невозможно быстро отрефакторить код с экспериментальным функционалом или если хочется проверить, какой подход окажется полезнее.<br /> <br /> Сердце всего BE5 - это ServiceProvider. ServiceProvider доступен компонентам, а в конструкторы сервисов инжектируются другие сервисы или сам ServiceProvider.<br /> <br /> Good practices:<br /> * Разделяем модельные элементы на бины без логики, сервисы и репозитории.<br /> * Презентационный код пишется в компонентах. Если в компоненте много строчек кода, то что-то пошло не так.<br /> <br /> Нерешённые проблемы:<br /> * При написании operation почти любая строчка кода приводит к увеличению зависимости от наличия метаданных в БД, а также ухудшению возможности что либо протестировать, равно как и невозможности переиспользовать написанный код. Необходимо новое API для операций, полагающееся на сервисы - содержимого com.beanexplorer.enterprise.api.experimental и com.beanexplorer.enterprise.api.experimental.v1 недостаточно.<br /> * Нет предусмотренного сетапа для тестирования.<br /> * Нет API для запросов из БД, которое покрывает все возможные SQL запросы.<br /> * Мы не избавились от метаданных в базе данных, поскольку BeanExplorer5 использует legacy код, который полагается на наличие метаданных в базе данных.<br /> <br /> Tips на будущее:<br /> * Можно ресширить функционал ServiceProvider добавлением способности обрабатывать аннотированные поля сервисов - это избавит от проблем обхода циклических зависимостей сервисов и написания boilderplate в конструкторах. Также возможно попробовать сэмулировать поведение из Spring Core или Google Guice - это бы позволило просто перйти на них при возможности (см. следующее).<br /> * Можно даже использовать Google Guice или переиспользовать Spring Core, если найдётся хороший способ регистрации сервисов из разных OSGi модулей (сам BE5 и BE5 приложение - в разных OSGi модулях).<br /> * В идеальном случае было бы хорошо не писать репозитории, да и сервисы для запросов - для этого есть Hibernate, реализации JPA и другие ORM. А ещё лучше - попробовать переиспользовать Spring Data (объявлять интерфейсы с методами, описывающими запрос, без необходимости писать сам код запроса - как personRepository.findByEmailAndActive(&quot;email&quot;, true) - вызов метода из интерфейса, реализацию которого подкладывает Spring).<br /> * Или хотя бы доделать SQL builder (SqlBuilder) и SQL Service (SqlService), потому что они сейчас не позволяют делать запросы с LEFT JOIN и WITH RECURSIVE.<br /> <br /> ==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> ==BeanExplorer5 API==<br /> См. [[BeanExplorer5 API|BeanExplorer5 API]]<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5 2016-05-10T10:44:10Z

<p>Asko: </p> <hr /> <div>&lt;big&gt;Это основная статья о BeanExplorer5.&lt;/big&gt;<br /> <br /> Поскольку эта основная статья недописана, остальная её часть для тех, кто будет дорабатывать BeanExplorer5, а не использовать.<br /> <br /> ==Концепции==<br /> <br /> Основные технологии, которые мы используем - это Java, Java Servlet, OSGi, React, SystemJS, ES2015 через Babel.<br /> <br /> ===Frontend===<br /> <br /> Основные frontend компоненты написаны на React, но могут быть написаны на чём угодно. Поскольку React - это лишь &quot;V&quot; из MVC, то часть функционала полноценного frontend framework было необходимо реализовать, и этот функционал находится в be5/be5-frontend/src/scripts/be5.js (или просто be5 - далее буду писать имена скриптов кратко). Это покрывает функционал routing, requests, frontend localization. Также полезный базовый функционал находится в be5/bus, be5/createStore, be5/createSimpleStore, be5/ext.<br /> * bus - сообщения (брокер из паттерна pub/sub); например, bus.fire('DocumentChange', value), bus.listen('DocumentChange', value =&gt; ...);<br /> * ext - расширения;<br /> * createStore - создание store для управления данными на frontend; позволяет подписаться на его изменения;<br /> * createSimpleStore - создание store, полным состоянием которого является результат GET запроса.<br /> <br /> Необходимые части frontend подгружаются динамически с помощью SystemJS.<br /> <br /> JSX+ES2015 скрипты компилируются с помощью Babel при сборке проекта.<br /> <br /> Нерешённые проблемы:<br /> * frontend подготовлен, но не переведён на [https://github.com/reactjs/react-redux redux], а это необходимо для упрощения работы с React компонентами (без redux или Flux бывает довольно нетривиально управлять состоянием React компонентов);<br /> * be5.js требует разделения на небольшие части, также, как выделены bus и ext;<br /> * невозможно отказаться от компиляции ES2015, даже если она будет поддерживаться всеми браузерами. SystemJS проверяет наличие ES2015 синтаксиса в скриптах, и в случае его наличия потается использовать транслятор в браузере, даже если явно указано, что транслятора нет<br /> <br /> Tips на будущее:<br /> * используйте [https://github.com/reactjs/react-redux redux], [https://facebook.github.io/react/docs/two-way-binding-helpers.html React two-way binding], [https://github.com/JedWatson/classnames React classNames].<br /> <br /> ===Backend===<br /> <br /> Основные части API находятся в com.beanexplorer.enterprise.api. Проще всего начать знакомство с BE5, посмотрев на содержимое этого пакета и его подпакетов. В com.beanexplorer.enterprise.api.experimental.v1 хранятся маленькие полезности. Если они становятся не экспериментальными, а доказавшими полезность, можно переносить их в другие подпакеты api. v1 в названии пакета необходимо для поддержки разного API для одинакового функционала, если невозможно быстро отрефакторить код с экспериментальным функционалом или если хочется проверить, какой подход окажется полезнее.<br /> <br /> Сердце всего BE5 - это ServiceProvider. ServiceProvider доступен компонентам, а в конструкторы сервисов инжектируются другие сервисы или сам ServiceProvider.<br /> <br /> Good practices:<br /> * Разделяем модельные элементы на бины без логики, сервисы и репозитории.<br /> * Презентационный код пишется в компонентах. Если в компоненте много строчек кода, то что-то пошло не так.<br /> <br /> Нерешённые проблемы:<br /> * При написании operation почти любая строчка кода приводит к увеличению зависимости от наличия метаданных в БД, а также ухудшению возможности что либо протестировать, равно как и невозможности переиспользовать написанный код. Необходимо новое API для операций, полагающееся на сервисы - содержимого com.beanexplorer.enterprise.api.experimental и com.beanexplorer.enterprise.api.experimental.v1 недостаточно.<br /> * Нет предусмотренного сетапа для тестирования.<br /> * Нет API для запросов из БД, которое покрывает все возможные SQL запросы.<br /> <br /> Tips на будущее:<br /> * Можно ресширить функционал ServiceProvider добавлением способности обрабатывать аннотированные поля сервисов - это избавит от проблем обхода циклических зависимостей сервисов и написания boilderplate в конструкторах. Также возможно попробовать сэмулировать поведение из Spring Core или Google Guice - это бы позволило просто перйти на них при возможности (см. следующее).<br /> * Можно даже использовать Google Guice или переиспользовать Spring Core, если найдётся хороший способ регистрации сервисов из разных OSGi модулей (сам BE5 и BE5 приложение - в разных OSGi модулях).<br /> * В идеальном случае было бы хорошо не писать репозитории, да и сервисы для запросов - для этого есть Hibernate, реализации JPA и другие ORM. А ещё лучше - попробовать переиспользовать Spring Data (объявлять интерфейсы с методами, описывающими запрос, без необходимости писать сам код запроса - как personRepository.findByEmailAndActive(&quot;email&quot;, true) - вызов метода из интерфейса, реализацию которого подкладывает Spring).<br /> * Или хотя бы доделать SQL builder (SqlBuilder) и SQL Service (SqlService), потому что они сейчас не позволяют делать запросы с LEFT JOIN и WITH RECURSIVE.<br /> <br /> ==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> ==BeanExplorer5 API==<br /> См. [[BeanExplorer5 API|BeanExplorer5 API]]<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5 2016-05-10T10:38:13Z

<p>Asko: /* Backend */</p> <hr /> <div>&lt;big&gt;Это основная статья о BeanExplorer5.&lt;/big&gt;<br /> <br /> Описание API [[BeanExplorer5 API|здесь]]. Поскольку эта основная статья недописана, остальная её часть статьи написана для тех, кто будет дорабатывать BeanExplorer5.<br /> <br /> ==Концепции==<br /> <br /> Основные технологии, которые мы используем - это Java, Java Servlet, OSGi, React, SystemJS, ES2015 через Babel.<br /> <br /> ===Frontend===<br /> <br /> Основные frontend компоненты написаны на React, но могут быть написаны на чём угодно. Поскольку React - это лишь &quot;V&quot; из MVC, то часть функционала полноценного frontend framework было необходимо реализовать, и этот функционал находится в be5/be5-frontend/src/scripts/be5.js (или просто be5 - далее буду писать имена скриптов кратко). Это покрывает функционал routing, requests, frontend localization. Также полезный базовый функционал находится в be5/bus, be5/createStore, be5/createSimpleStore, be5/ext.<br /> * bus - сообщения (брокер из паттерна pub/sub); например, bus.fire('DocumentChange', value), bus.listen('DocumentChange', value =&gt; ...);<br /> * ext - расширения;<br /> * createStore - создание store для управления данными на frontend; позволяет подписаться на его изменения;<br /> * createSimpleStore - создание store, полным состоянием которого является результат GET запроса.<br /> <br /> Необходимые части frontend подгружаются динамически с помощью SystemJS.<br /> <br /> JSX+ES2015 скрипты компилируются с помощью Babel при сборке проекта.<br /> <br /> Нерешённые проблемы:<br /> * frontend подготовлен, но не переведён на [https://github.com/reactjs/react-redux redux], а это необходимо для упрощения работы с React компонентами (без redux или Flux бывает довольно нетривиально управлять состоянием React компонентов);<br /> * be5.js требует разделения на небольшие части, также, как выделены bus и ext;<br /> * невозможно отказаться от компиляции ES2015, даже если она будет поддерживаться всеми браузерами. SystemJS проверяет наличие ES2015 синтаксиса в скриптах, и в случае его наличия потается использовать транслятор в браузере, даже если явно указано, что транслятора нет<br /> <br /> Tips на будущее:<br /> * используйте [https://github.com/reactjs/react-redux redux], [https://facebook.github.io/react/docs/two-way-binding-helpers.html React two-way binding], [https://github.com/JedWatson/classnames React classNames].<br /> <br /> ===Backend===<br /> <br /> Основные части API находятся в com.beanexplorer.enterprise.api. Проще всего начать знакомство с BE5, посмотрев на содержимое этого пакета и его подпакетов. В com.beanexplorer.enterprise.api.experimental.v1 хранятся маленькие полезности. Если они становятся не экспериментальными, а доказавшими полезность, можно переносить их в другие подпакеты api. v1 в названии пакета необходимо для поддержки разного API для одинакового функционала, если невозможно быстро отрефакторить код с экспериментальным функционалом или если хочется проверить, какой подход окажется полезнее.<br /> <br /> Сердце всего BE5 - это ServiceProvider. ServiceProvider доступен компонентам, а в конструкторы сервисов инжектируются другие сервисы или сам ServiceProvider.<br /> <br /> Good practices:<br /> * Разделяем модельные элементы на бины без логики, сервисы и репозитории.<br /> * Презентационный код пишется в компонентах. Если в компоненте много строчек кода, то что-то пошло не так.<br /> <br /> Нерешённые проблемы:<br /> * При написании operation почти любая строчка кода приводит к увеличению зависимости от наличия метаданных в БД, а также ухудшению возможности что либо протестировать, равно как и невозможности переиспользовать написанный код. Необходимо новое API для операций, полагающееся на сервисы - содержимого com.beanexplorer.enterprise.api.experimental и com.beanexplorer.enterprise.api.experimental.v1 недостаточно.<br /> * Нет предусмотренного сетапа для тестирования.<br /> * Нет API для запросов из БД, которое покрывает все возможные SQL запросы.<br /> <br /> Tips на будущее:<br /> * Можно ресширить функционал ServiceProvider добавлением способности обрабатывать аннотированные поля сервисов - это избавит от проблем обхода циклических зависимостей сервисов и написания boilderplate в конструкторах. Также возможно попробовать сэмулировать поведение из Spring Core или Google Guice - это бы позволило просто перйти на них при возможности (см. следующее).<br /> * Можно даже использовать Google Guice или переиспользовать Spring Core, если найдётся хороший способ регистрации сервисов из разных OSGi модулей (сам BE5 и BE5 приложение - в разных OSGi модулях).<br /> * В идеальном случае было бы хорошо не писать репозитории, да и сервисы для запросов - для этого есть Hibernate, реализации JPA и другие ORM. А ещё лучше - попробовать переиспользовать Spring Data (объявлять интерфейсы с методами, описывающими запрос, без необходимости писать сам код запроса - как personRepository.findByEmailAndActive(&quot;email&quot;, true) - вызов метода из интерфейса, реализацию которого подкладывает Spring).<br /> * Или хотя бы доделать SQL builder (SqlBuilder) и SQL Service (SqlService), потому что они сейчас не позволяют делать запросы с LEFT JOIN и WITH RECURSIVE.<br /> <br /> ==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5 2016-05-10T10:35:27Z

<p>Asko: /* Концепции */</p> <hr /> <div>&lt;big&gt;Это основная статья о BeanExplorer5.&lt;/big&gt;<br /> <br /> Описание API [[BeanExplorer5 API|здесь]]. Поскольку эта основная статья недописана, остальная её часть статьи написана для тех, кто будет дорабатывать BeanExplorer5.<br /> <br /> ==Концепции==<br /> <br /> Основные технологии, которые мы используем - это Java, Java Servlet, OSGi, React, SystemJS, ES2015 через Babel.<br /> <br /> ===Frontend===<br /> <br /> Основные frontend компоненты написаны на React, но могут быть написаны на чём угодно. Поскольку React - это лишь &quot;V&quot; из MVC, то часть функционала полноценного frontend framework было необходимо реализовать, и этот функционал находится в be5/be5-frontend/src/scripts/be5.js (или просто be5 - далее буду писать имена скриптов кратко). Это покрывает функционал routing, requests, frontend localization. Также полезный базовый функционал находится в be5/bus, be5/createStore, be5/createSimpleStore, be5/ext.<br /> * bus - сообщения (брокер из паттерна pub/sub); например, bus.fire('DocumentChange', value), bus.listen('DocumentChange', value =&gt; ...);<br /> * ext - расширения;<br /> * createStore - создание store для управления данными на frontend; позволяет подписаться на его изменения;<br /> * createSimpleStore - создание store, полным состоянием которого является результат GET запроса.<br /> <br /> Необходимые части frontend подгружаются динамически с помощью SystemJS.<br /> <br /> JSX+ES2015 скрипты компилируются с помощью Babel при сборке проекта.<br /> <br /> Нерешённые проблемы:<br /> * frontend подготовлен, но не переведён на [https://github.com/reactjs/react-redux redux], а это необходимо для упрощения работы с React компонентами (без redux или Flux бывает довольно нетривиально управлять состоянием React компонентов);<br /> * be5.js требует разделения на небольшие части, также, как выделены bus и ext;<br /> * невозможно отказаться от компиляции ES2015, даже если она будет поддерживаться всеми браузерами. SystemJS проверяет наличие ES2015 синтаксиса в скриптах, и в случае его наличия потается использовать транслятор в браузере, даже если явно указано, что транслятора нет<br /> <br /> Tips на будущее:<br /> * используйте [https://github.com/reactjs/react-redux redux], [https://facebook.github.io/react/docs/two-way-binding-helpers.html React two-way binding], [https://github.com/JedWatson/classnames React classNames].<br /> <br /> ===Backend===<br /> <br /> Основные части API находятся в com.beanexplorer.enterprise.api. Проще всего начать знакомство с BE5, посмотрев на содержимое этого пакета и его подпакетов. В com.beanexplorer.enterprise.api.experimental.v1 хранятся маленькие полезности. Если они становятся не экспериментальными, а доказавшими полезность, можно переносить их в другие подпакеты api. v1 в названии пакета необходимо для поддержки разного API для одинакового функционала, если невозможно быстро отрефакторить код с экспериментальным функционалом или если хочется проверить, какой подход окажется полезнее.<br /> <br /> Сердце всего BE5 - это ServiceProvider. ServiceProvider доступен компонентам, а в конструкторы сервисов инжектируются другие сервисы или сам ServiceProvider.<br /> <br /> Good practices:<br /> * Разделяем модельные элементы на бины без логики, сервисы и репозитории.<br /> * Презентационный код пишется в компонентах. Если в компоненте много строчек кода, то что-то пошло не так.<br /> <br /> Нерешённые проблемы:<br /> * При написании operation почти любая строчка кода приводит к увеличению зависимости от наличия метаданных в БД, а также ухудшению возможности что либо протестировать, равно как и невозможности переиспользовать написанный код. Необходимо новое API для операций, полагающееся на сервисы - содержимого com.beanexplorer.enterprise.api.experimental и com.beanexplorer.enterprise.api.experimental.v1 недостаточно.<br /> * Нет предусмотренного сетапа для тестирования.<br /> * Нет API для запросов из БД, которое покрывает все возможные SQL запросы.<br /> <br /> Tips на будущее:<br /> * Можно ресширить функционал ServiceProvider добавлением способности обрабатывать аннотированные поля сервисов - это избавит от проблем обхода циклических зависимостей сервисов и написания boilderplate в конструкторах. Также возможно попробовать сэмулировать поведение из Spring Core или Google Guice - это бы позволило просто перйти на них при возможности (см. следующее).<br /> * Можно даже использовать Google Guice или переиспользовать Spring Core, если найдётся хороший способ регистрации сервисов из разных OSGi модулей (сам BE5 и BE5 приложение - в разных OSGi модулях).<br /> * В идеальном случае было бы хорошо не писать репозитории, да и сервисы для запросов - для этого есть Hibernate, реализации JPA и другие ORM. А ещё лучше - попробовать переиспользовать Spring Data (объявлять интерфейсы с методами, описывающими запрос, без необходимости писать сам код запроса - как personRepository.findByEmailAndActive(&quot;email&quot;, true) - вызов метода из интерфейса, реализацию которого подкладывает Spring).<br /> * Или хотя бы доделать SQL builder и SqlService, потому что они сейчас не позволяют делать запросы с LEFT JOIN и WITH RECURSIVE.<br /> <br /> ==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5 2016-05-10T10:10:51Z

<p>Asko: </p> <hr /> <div>&lt;big&gt;Это основная статья о BeanExplorer5.&lt;/big&gt;<br /> <br /> Описание API [[BeanExplorer5 API|здесь]]. Поскольку эта основная статья недописана, остальная её часть статьи написана для тех, кто будет дорабатывать BeanExplorer5.<br /> <br /> ==Концепции==<br /> <br /> Основные технологии, которые мы используем - это Java, Java Servlet, OSGi, React, SystemJS, ES2015 через Babel.<br /> <br /> ===Frontend===<br /> <br /> Основные frontend компоненты написаны на React, но могут быть написаны на чём угодно. Поскольку React - это лишь &quot;V&quot; из MVC, то часть функционала полноценного frontend framework было необходимо реализовать, и этот функционал находится в be5/be5-frontend/src/scripts/be5.js (или просто be5 - далее буду писать имена скриптов кратко). Это покрывает функционал routing, requests, frontend localization. Также полезный базовый функционал находится в be5/bus, be5/createStore, be5/createSimpleStore, be5/ext.<br /> * bus - сообщения (брокер из паттерна pub/sub); например, bus.fire('DocumentChange', value), bus.listen('DocumentChange', value =&gt; ...);<br /> * ext - расширения;<br /> * createStore - создание store для управления данными на frontend; позволяет подписаться на его изменения;<br /> * createSimpleStore - создание store, полным состоянием которого является результат GET запроса.<br /> <br /> Необходимые части frontend подгружаются динамически с помощью SystemJS.<br /> <br /> JSX+ES2015 скрипты компилируются с помощью Babel при сборке проекта.<br /> <br /> Нерешённые проблемы:<br /> * frontend подготовлен, но не переведён на [https://github.com/reactjs/react-redux redux], а это необходимо для упрощения работы с React компонентами (без redux или Flux бывает довольно нетривиально управлять состоянием React компонентов);<br /> * be5.js требует разделения на небольшие части, также, как выделены bus и ext;<br /> * невозможно отказаться от компиляции ES2015, даже если она будет поддерживаться всеми браузерами. SystemJS проверяет наличие ES2015 синтаксиса в скриптах, и в случае его наличия потается использовать транслятор в браузере, даже если явно указано, что транслятора нет<br /> <br /> Tips на будущее:<br /> * используйте [https://github.com/reactjs/react-redux redux], [https://facebook.github.io/react/docs/two-way-binding-helpers.html React two-way binding], [https://github.com/JedWatson/classnames React classNames].<br /> <br /> ==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/%D0%9A%D0%BE%D0%BC%D0%BF%D0%B8%D0%BB%D1%8F%D1%86%D0%B8%D1%8F_%D0%B8_%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA_BeanExplorer4 2016-01-25T08:37:10Z

<p>Asko: /* Простой запуск */</p> <hr /> <div>=== Простой запуск ===<br /> Простой запуск:<br /> # убедиться, что установлена Java 8 (JRE достаточно);<br /> # поместить исходники be4 в C:\projects\java\be4;<br /> # взять Eclipse IDE for Java EE Developers, Eclipse Luna SR2 из этой папки: \\logrus.dote.ru\pub2\be4;<br /> # отсюда же устанавливаем наши плагины, для этого заходим в Help -&gt; Install New Software..., Add... копируем file:////logrus.dote.ru/pub2/be4/com.beanexplorer.be4.site/ в Location, OK, снимаем галочку Group items by category (если список фич пуст), ставим галочку на BeanExplorer4, Next и т.д.<br /> <br /> После перезагрузки Eclipse для работы с BE4 нужно будет выбрать перспективу BeanExplorer. При этом (или же при запуске Eclipse) Eclipse спросит, откуда взять исходники be4, если не догадается об их местоположении. В случае, если be4 находится в C:\projects\java\be4, то всё должно происходить само. Эти исходники нужны только для загрузки модулей.<br /> <br /> Известный баг: если be4 помещён не в C:\projects\java\be4, то Eclipse каждый раз при запуске будет спрашивать местонахождение be4.<br /> <br /> === Запуск из-под Eclipse ===<br /> Для компиляции необходимы<br /> # '''Java 8''' [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html отсюда],<br /> # '''Eclipse IDE for Java EE Developers''', Eclipse '''Luna SR2''' [http://www.eclipse.org/downloads/packages/release/luna/sr2 отсюда],<br /> # '''Наша версия Freemarker IDE''' - обычно мы импортируем проекты org.freemarker.core и org.jboss.ide.eclipse.freemarker из публичного репозитория https://github.com/amaembo/jbosstools-freemarker.git (см. ниже),<br /> # '''IvyDE''' - устанавливается из Eclipse MarketPlace,<br /> # '''YEdit''' - устанавливается из Eclipse MarketPlace,<br /> # Наш проект '''common''' - его необходимо импортировать в workspace.<br /> <br /> Необходимо создать API baseline. Для этого заходим в Window -&gt; Preferences, Plug-in Development -&gt; API Baselines, там вводим любое Name, нажимаем Reset, Finish, Apply, OK.<br /> <br /> Необходимо создать конфигурацию запуска. Заходим в &quot;Debug Configurations...&quot; (можно нажать Ctrl+3 и начать печатать &quot;Debug Configurations&quot;), там кликаем два раза на Eclipse Application, открываем вкладку Plug-ins, выбираем &quot;Launch with: all workspace and enabled target plug-ins&quot;, нажимаем Apply, Debug (потом при запуске просто будем нажимать F11 вместо входа сюда). Помимо этого см. настройки запуска ниже.<br /> <br /> Для проверки того, что всё установлено и будет корректно работать, нужно зайти на вкладку Plug-ins конфигурации запуска и там нажать &quot;Validate Plug-ins&quot; чтобы убедиться, что все необходимые плагины имеются.<br /> ----<br /> <br /> === Варианты установки Freemarker IDE ===<br /> ==== Вариант 1 (запуск без исходного кода Freemarker IDE). ====<br /> Установить содержимое \\files.dote.ru\pub2\_be4\Installation\freemarker.feature.zip<br /> # Заходим в... Help-&gt;Install New Software. Add...-&gt;Archive... выбрать архив, OK.<br /> # Снять галочку &quot;Group items by category&quot;, если не видно пунктов для установки.<br /> <br /> ==== Вариант 2 (для разработчиков Freemarker IDE). ====<br /> # Необходим репозиторий https://github.com/amaembo/jbosstools-freemarker.git<br /> # После скачивания репозитория нужно импортировать два проекта:<br /> #*- org.freemarker.core<br /> #*- org.jboss.ide.eclipse.freemarker. Остальные проекты можно не импортировать или просто закрыть.<br /> # Windows -&gt; Preferences; Plug-In Development -&gt; API Baselines; ввести произвольное имя, Reset, Finish, Apply, OK.<br /> <br /> === Настройки запуска: ===<br /> # Run-&gt;Debug Configurations..., выбрать Eclipse Application, нажать New launch configuration.<br /> # Выбрать каталог в Workspace data (лучше создать новый пустой, например, c:\projects\be4-workspace).<br /> # Execution environment -&gt; Java 1.8.<br /> # Вкладка Arguments Скопировать это значение в поле VM Arguments: '''-Dosgi.requiredJavaVersion=1.8 -Xms256m -Xmx768m -ea'''<br /> # Apply, Debug.</div>

Asko http://wiki.dote.ru/index.php/%D0%9A%D0%BE%D0%BC%D0%BF%D0%B8%D0%BB%D1%8F%D1%86%D0%B8%D1%8F_%D0%B8_%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA_BeanExplorer4 2016-01-25T08:36:24Z

<p>Asko: </p> <hr /> <div>=== Простой запуск ===<br /> Простой запуск:<br /> # убедиться, что установлена Java 8 (JRE достаточно);<br /> # поместить исходники be4 в C:\projects\java\be4;<br /> # взять Eclipse IDE for Java EE Developers, Eclipse Luna SR2 из этой папки: \\logrus.dote.ru\pub2\be4;<br /> # отсюда же устанавливаем наши плагины, для этого заходим в Help -&gt; Install New Software..., Add... копируем file:////logrus.dote.ru/pub2/be4/com.beanexplorer.be4.site/ в Location, OK, снимаем галочку Group items by category (если список фич пуст), ставим галочку на BeanExplorer4, Next и т.д.<br /> <br /> После перезагрузки Eclipse для работы с BE4 нужно будет выбрать перспективу BeanExplorer. При этом (или же при запуске Eclipse) Eclipse спросит, откуда взять исходники be4, если не догадается об их местоположении. В случае, если be4 находится в C:\projects\java\be4, то всё должно происходить само. Эти исходники нужны только для загрузки модулей.<br /> <br /> === Запуск из-под Eclipse ===<br /> Для компиляции необходимы<br /> # '''Java 8''' [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html отсюда],<br /> # '''Eclipse IDE for Java EE Developers''', Eclipse '''Luna SR2''' [http://www.eclipse.org/downloads/packages/release/luna/sr2 отсюда],<br /> # '''Наша версия Freemarker IDE''' - обычно мы импортируем проекты org.freemarker.core и org.jboss.ide.eclipse.freemarker из публичного репозитория https://github.com/amaembo/jbosstools-freemarker.git (см. ниже),<br /> # '''IvyDE''' - устанавливается из Eclipse MarketPlace,<br /> # '''YEdit''' - устанавливается из Eclipse MarketPlace,<br /> # Наш проект '''common''' - его необходимо импортировать в workspace.<br /> <br /> Необходимо создать API baseline. Для этого заходим в Window -&gt; Preferences, Plug-in Development -&gt; API Baselines, там вводим любое Name, нажимаем Reset, Finish, Apply, OK.<br /> <br /> Необходимо создать конфигурацию запуска. Заходим в &quot;Debug Configurations...&quot; (можно нажать Ctrl+3 и начать печатать &quot;Debug Configurations&quot;), там кликаем два раза на Eclipse Application, открываем вкладку Plug-ins, выбираем &quot;Launch with: all workspace and enabled target plug-ins&quot;, нажимаем Apply, Debug (потом при запуске просто будем нажимать F11 вместо входа сюда). Помимо этого см. настройки запуска ниже.<br /> <br /> Для проверки того, что всё установлено и будет корректно работать, нужно зайти на вкладку Plug-ins конфигурации запуска и там нажать &quot;Validate Plug-ins&quot; чтобы убедиться, что все необходимые плагины имеются.<br /> ----<br /> <br /> === Варианты установки Freemarker IDE ===<br /> ==== Вариант 1 (запуск без исходного кода Freemarker IDE). ====<br /> Установить содержимое \\files.dote.ru\pub2\_be4\Installation\freemarker.feature.zip<br /> # Заходим в... Help-&gt;Install New Software. Add...-&gt;Archive... выбрать архив, OK.<br /> # Снять галочку &quot;Group items by category&quot;, если не видно пунктов для установки.<br /> <br /> ==== Вариант 2 (для разработчиков Freemarker IDE). ====<br /> # Необходим репозиторий https://github.com/amaembo/jbosstools-freemarker.git<br /> # После скачивания репозитория нужно импортировать два проекта:<br /> #*- org.freemarker.core<br /> #*- org.jboss.ide.eclipse.freemarker. Остальные проекты можно не импортировать или просто закрыть.<br /> # Windows -&gt; Preferences; Plug-In Development -&gt; API Baselines; ввести произвольное имя, Reset, Finish, Apply, OK.<br /> <br /> === Настройки запуска: ===<br /> # Run-&gt;Debug Configurations..., выбрать Eclipse Application, нажать New launch configuration.<br /> # Выбрать каталог в Workspace data (лучше создать новый пустой, например, c:\projects\be4-workspace).<br /> # Execution environment -&gt; Java 1.8.<br /> # Вкладка Arguments Скопировать это значение в поле VM Arguments: '''-Dosgi.requiredJavaVersion=1.8 -Xms256m -Xmx768m -ea'''<br /> # Apply, Debug.</div>

Asko http://wiki.dote.ru/index.php/%D0%9A%D0%BE%D0%BC%D0%BF%D0%B8%D0%BB%D1%8F%D1%86%D0%B8%D1%8F_%D0%B8_%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA_BeanExplorer4 2016-01-22T10:49:00Z

<p>Asko: /* Запуск из-под Eclipse */</p> <hr /> <div>=== Простой запуск ===<br /> Самый простой запуск:<br /> # убедиться, что установлена Java 8 (JRE достаточно);<br /> # установить из Eclipse MarketPlace плагин IvyDE.<br /> # поместить исходники be4 в любую папку;<br /> # сделать одно из следующих действий:<br /> #* скачать готовый Eclipse для Windows x64 с files.dote.ru (обычно это архив eclipse.zip в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation) и разархивировать в любую папку;<br /> #* скачать Eclipse для своей ОС и установить на него содержимое архива repository.zip (обычно он находится в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation).<br /> <br /> При запуске eclipse.exe спросит, откуда взять исходники be4, если не догадается об их местоположении.<br /> <br /> === Запуск из-под Eclipse ===<br /> Для компиляции необходимы<br /> # '''Java 8''' [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html отсюда],<br /> # '''Eclipse IDE for Java EE Developers''', Eclipse '''Luna SR2''' [http://www.eclipse.org/downloads/packages/release/luna/sr2 отсюда],<br /> # '''Наша версия Freemarker IDE''' - обычно мы импортируем проекты org.freemarker.core и org.jboss.ide.eclipse.freemarker из публичного репозитория https://github.com/amaembo/jbosstools-freemarker.git (см. ниже),<br /> # '''IvyDE''' - устанавливается из Eclipse MarketPlace,<br /> # '''YEdit''' - устанавливается из Eclipse MarketPlace,<br /> # Наш проект '''common''' - его необходимо импортировать в workspace.<br /> <br /> Необходимо создать API baseline. Для этого заходим в Window -&gt; Preferences, Plug-in Development -&gt; API Baselines, там вводим любое Name, нажимаем Reset, Finish, Apply, OK.<br /> <br /> Необходимо создать конфигурацию запуска. Заходим в &quot;Debug Configurations...&quot; (можно нажать Ctrl+3 и начать печатать &quot;Debug Configurations&quot;), там кликаем два раза на Eclipse Application, открываем вкладку Plug-ins, выбираем &quot;Launch with: all workspace and enabled target plug-ins&quot;, нажимаем Apply, Debug (потом при запуске просто будем нажимать F11 вместо входа сюда). Помимо этого см. настройки запуска ниже.<br /> <br /> Для проверки того, что всё установлено и будет корректно работать, нужно зайти на вкладку Plug-ins конфигурации запуска и там нажать &quot;Validate Plug-ins&quot; чтобы убедиться, что все необходимые плагины имеются.<br /> ----<br /> <br /> === Варианты установки Freemarker IDE ===<br /> ==== Вариант 1 (запуск без исходного кода Freemarker IDE). ====<br /> Установить содержимое \\files.dote.ru\pub2\_be4\Installation\freemarker.feature.zip<br /> # Заходим в... Help-&gt;Install New Software. Add...-&gt;Archive... выбрать архив, OK.<br /> # Снять галочку &quot;Group items by category&quot;, если не видно пунктов для установки.<br /> <br /> ==== Вариант 2 (для разработчиков Freemarker IDE). ====<br /> # Необходим репозиторий https://github.com/amaembo/jbosstools-freemarker.git<br /> # После скачивания репозитория нужно импортировать два проекта:<br /> #*- org.freemarker.core<br /> #*- org.jboss.ide.eclipse.freemarker. Остальные проекты можно не импортировать или просто закрыть.<br /> # Windows -&gt; Preferences; Plug-In Development -&gt; API Baselines; ввести произвольное имя, Reset, Finish, Apply, OK.<br /> <br /> === Настройки запуска: ===<br /> # Run-&gt;Debug Configurations..., выбрать Eclipse Application, нажать New launch configuration.<br /> # Выбрать каталог в Workspace data (лучше создать новый пустой, например, c:\projects\be4-workspace).<br /> # Execution environment -&gt; Java 1.8.<br /> # Вкладка Arguments Скопировать это значение в поле VM Arguments: '''-Dosgi.requiredJavaVersion=1.8 -Xms256m -Xmx768m -ea'''<br /> # Apply, Debug.</div>

Asko http://wiki.dote.ru/index.php/%D0%9A%D0%BE%D0%BC%D0%BF%D0%B8%D0%BB%D1%8F%D1%86%D0%B8%D1%8F_%D0%B8_%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA_BeanExplorer4 2016-01-22T10:47:13Z

<p>Asko: /* Запуск из-под Eclipse */</p> <hr /> <div>=== Простой запуск ===<br /> Самый простой запуск:<br /> # убедиться, что установлена Java 8 (JRE достаточно);<br /> # установить из Eclipse MarketPlace плагин IvyDE.<br /> # поместить исходники be4 в любую папку;<br /> # сделать одно из следующих действий:<br /> #* скачать готовый Eclipse для Windows x64 с files.dote.ru (обычно это архив eclipse.zip в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation) и разархивировать в любую папку;<br /> #* скачать Eclipse для своей ОС и установить на него содержимое архива repository.zip (обычно он находится в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation).<br /> <br /> При запуске eclipse.exe спросит, откуда взять исходники be4, если не догадается об их местоположении.<br /> <br /> === Запуск из-под Eclipse ===<br /> Для компиляции необходимы<br /> # '''Java 8''' [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html отсюда],<br /> # '''Eclipse IDE for Java EE Developers''', Eclipse '''Luna SR2''' [http://www.eclipse.org/downloads/packages/release/luna/sr2 отсюда],<br /> # '''Наша версия Freemarker IDE''' - обычно мы импортируем проекты org.freemarker.core и org.jboss.ide.eclipse.freemarker из публичного репозитория https://github.com/amaembo/jbosstools-freemarker.git (см. ниже),<br /> # '''IvyDE''' - устанавливается из Eclipse MarketPlace,<br /> # '''YEdit''' - устанавливается из Eclipse MarketPlace,<br /> # Наш проект '''common''' - его необходимо импортировать в workspace.<br /> <br /> Необходимо создать API baseline. Для этого заходим в Window -&gt; Preferences, Plug-in Development -&gt; API Baselines, там вводим любое Name, нажимаем Reset, Finish, Apply, OK.<br /> <br /> Необходимо создать конфигурацию запуска. Заходим в &quot;Debug Configurations...&quot; (можно нажать Ctrl+3 и начать печатать &quot;Debug Configurations&quot;), там кликаем два раза на Eclipse Application, открываем вкладку Plug-ins, выбираем &quot;Launch with: all workspace and enabled target plug-ins&quot;, нажимаем Apply, Debug (потом при запуске просто будем нажимать F11 вместо входа сюда).<br /> <br /> Для проверки того, что всё установлено и будет корректно работать, нужно зайти на вкладку Plug-ins конфигурации запуска и там нажать &quot;Validate Plug-ins&quot; чтобы убедиться, что все необходимые плагины имеются.<br /> ----<br /> <br /> === Варианты установки Freemarker IDE ===<br /> ==== Вариант 1 (запуск без исходного кода Freemarker IDE). ====<br /> Установить содержимое \\files.dote.ru\pub2\_be4\Installation\freemarker.feature.zip<br /> # Заходим в... Help-&gt;Install New Software. Add...-&gt;Archive... выбрать архив, OK.<br /> # Снять галочку &quot;Group items by category&quot;, если не видно пунктов для установки.<br /> <br /> ==== Вариант 2 (для разработчиков Freemarker IDE). ====<br /> # Необходим репозиторий https://github.com/amaembo/jbosstools-freemarker.git<br /> # После скачивания репозитория нужно импортировать два проекта:<br /> #*- org.freemarker.core<br /> #*- org.jboss.ide.eclipse.freemarker. Остальные проекты можно не импортировать или просто закрыть.<br /> # Windows -&gt; Preferences; Plug-In Development -&gt; API Baselines; ввести произвольное имя, Reset, Finish, Apply, OK.<br /> <br /> === Настройки запуска: ===<br /> # Run-&gt;Debug Configurations..., выбрать Eclipse Application, нажать New launch configuration.<br /> # Выбрать каталог в Workspace data (лучше создать новый пустой, например, c:\projects\be4-workspace).<br /> # Execution environment -&gt; Java 1.8.<br /> # Вкладка Arguments Скопировать это значение в поле VM Arguments: '''-Dosgi.requiredJavaVersion=1.8 -Xms256m -Xmx768m -ea'''<br /> # Apply, Debug.</div>

Asko http://wiki.dote.ru/index.php/%D0%9A%D0%BE%D0%BC%D0%BF%D0%B8%D0%BB%D1%8F%D1%86%D0%B8%D1%8F_%D0%B8_%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA_BeanExplorer4 2016-01-22T10:44:41Z

<p>Asko: /* Запуск из-под Eclipse */</p> <hr /> <div>=== Простой запуск ===<br /> Самый простой запуск:<br /> # убедиться, что установлена Java 8 (JRE достаточно);<br /> # установить из Eclipse MarketPlace плагин IvyDE.<br /> # поместить исходники be4 в любую папку;<br /> # сделать одно из следующих действий:<br /> #* скачать готовый Eclipse для Windows x64 с files.dote.ru (обычно это архив eclipse.zip в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation) и разархивировать в любую папку;<br /> #* скачать Eclipse для своей ОС и установить на него содержимое архива repository.zip (обычно он находится в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation).<br /> <br /> При запуске eclipse.exe спросит, откуда взять исходники be4, если не догадается об их местоположении.<br /> <br /> === Запуск из-под Eclipse ===<br /> Для компиляции необходимы<br /> # '''Java 8''' [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html отсюда],<br /> # '''Eclipse IDE for Java EE Developers''', Eclipse '''Luna SR2''' [http://www.eclipse.org/downloads/packages/release/luna/sr2 отсюда],<br /> # '''Наша версия Freemarker IDE''' - обычно мы импортируем проекты org.freemarker.core и org.jboss.ide.eclipse.freemarker,<br /> # '''IvyDE''' - устанавливается из Eclipse MarketPlace,<br /> # '''YEdit''' - устанавливается из Eclipse MarketPlace,<br /> # Наш проект '''common''' - его необходимо импортировать в workspace.<br /> <br /> Необходимо создать API baseline. Для этого заходим в Window -&gt; Preferences, Plug-in Development -&gt; API Baselines, там вводим любое Name, нажимаем Reset, Finish, Apply, OK.<br /> <br /> Необходимо создать конфигурацию запуска. Заходим в &quot;Debug Configurations...&quot; (можно нажать Ctrl+3 и начать печатать &quot;Debug Configurations&quot;), там кликаем два раза на Eclipse Application, открываем вкладку Plug-ins, выбираем &quot;Launch with: all workspace and enabled target plug-ins&quot;, нажимаем Apply, Debug (потом при запуске просто будем нажимать F11 вместо входа сюда).<br /> <br /> Для проверки того, что всё установлено и будет корректно работать, нужно зайти на вкладку Plug-ins конфигурации запуска и там нажать &quot;Validate Plug-ins&quot; чтобы убедиться, что все необходимые плагины имеются.<br /> ----<br /> <br /> === Варианты установки Freemarker IDE ===<br /> ==== Вариант 1 (запуск без исходного кода Freemarker IDE). ====<br /> Установить содержимое \\files.dote.ru\pub2\_be4\Installation\freemarker.feature.zip<br /> # Заходим в... Help-&gt;Install New Software. Add...-&gt;Archive... выбрать архив, OK.<br /> # Снять галочку &quot;Group items by category&quot;, если не видно пунктов для установки.<br /> <br /> ==== Вариант 2 (для разработчиков Freemarker IDE). ====<br /> # Необходим репозиторий https://github.com/amaembo/jbosstools-freemarker.git<br /> # После скачивания репозитория нужно импортировать два проекта:<br /> #*- org.freemarker.core<br /> #*- org.jboss.ide.eclipse.freemarker. Остальные проекты можно не импортировать или просто закрыть.<br /> # Windows -&gt; Preferences; Plug-In Development -&gt; API Baselines; ввести произвольное имя, Reset, Finish, Apply, OK.<br /> <br /> === Настройки запуска: ===<br /> # Run-&gt;Debug Configurations..., выбрать Eclipse Application, нажать New launch configuration.<br /> # Выбрать каталог в Workspace data (лучше создать новый пустой, например, c:\projects\be4-workspace).<br /> # Execution environment -&gt; Java 1.8.<br /> # Вкладка Arguments Скопировать это значение в поле VM Arguments: '''-Dosgi.requiredJavaVersion=1.8 -Xms256m -Xmx768m -ea'''<br /> # Apply, Debug.</div>

Asko http://wiki.dote.ru/index.php/%D0%9A%D0%BE%D0%BC%D0%BF%D0%B8%D0%BB%D1%8F%D1%86%D0%B8%D1%8F_%D0%B8_%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA_BeanExplorer4 2016-01-22T10:34:50Z

<p>Asko: /* Запуск из-под Eclipse */</p> <hr /> <div>=== Простой запуск ===<br /> Самый простой запуск:<br /> # убедиться, что установлена Java 8 (JRE достаточно);<br /> # установить из Eclipse MarketPlace плагин IvyDE.<br /> # поместить исходники be4 в любую папку;<br /> # сделать одно из следующих действий:<br /> #* скачать готовый Eclipse для Windows x64 с files.dote.ru (обычно это архив eclipse.zip в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation) и разархивировать в любую папку;<br /> #* скачать Eclipse для своей ОС и установить на него содержимое архива repository.zip (обычно он находится в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation).<br /> <br /> При запуске eclipse.exe спросит, откуда взять исходники be4, если не догадается об их местоположении.<br /> <br /> === Запуск из-под Eclipse ===<br /> Для компиляции необходимы<br /> # '''Java 8''' [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html отсюда],<br /> # '''Eclipse IDE for Java EE Developers''', Eclipse '''Luna SR2''' [http://www.eclipse.org/downloads/packages/release/luna/sr2 отсюда],<br /> # '''Наша версия Freemarker IDE''' - обычно мы импортируем проекты org.freemarker.core и org.jboss.ide.eclipse.freemarker,<br /> # '''IvyDE''' - устанавливается из Eclipse MarketPlace,<br /> # '''YEdit''' - устанавливается из Eclipse MarketPlace,<br /> # Наш проект '''common''' - его необходимо импортировать в workspace.<br /> <br /> ----<br /> <br /> === Варианты установки Freemarker IDE ===<br /> ==== Вариант 1 (запуск без исходного кода Freemarker IDE). ====<br /> Установить содержимое \\files.dote.ru\pub2\_be4\Installation\freemarker.feature.zip<br /> # Заходим в... Help-&gt;Install New Software. Add...-&gt;Archive... выбрать архив, OK.<br /> # Снять галочку &quot;Group items by category&quot;, если не видно пунктов для установки.<br /> <br /> ==== Вариант 2 (для разработчиков Freemarker IDE). ====<br /> # Необходим репозиторий https://github.com/amaembo/jbosstools-freemarker.git<br /> # После скачивания репозитория нужно импортировать два проекта:<br /> #*- org.freemarker.core<br /> #*- org.jboss.ide.eclipse.freemarker. Остальные проекты можно не импортировать или просто закрыть.<br /> # Windows -&gt; Preferences; Plug-In Development -&gt; API Baselines; ввести произвольное имя, Reset, Finish, Apply, OK.<br /> <br /> === Настройки запуска: ===<br /> # Run-&gt;Debug Configurations..., выбрать Eclipse Application, нажать New launch configuration.<br /> # Выбрать каталог в Workspace data (лучше создать новый пустой, например, c:\projects\be4-workspace).<br /> # Execution environment -&gt; Java 1.8.<br /> # Вкладка Arguments Скопировать это значение в поле VM Arguments: '''-Dosgi.requiredJavaVersion=1.8 -Xms256m -Xmx768m -ea'''<br /> # Apply, Debug.</div>

Asko http://wiki.dote.ru/index.php/%D0%9A%D0%BE%D0%BC%D0%BF%D0%B8%D0%BB%D1%8F%D1%86%D0%B8%D1%8F_%D0%B8_%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA_BeanExplorer4 2016-01-22T10:31:08Z

<p>Asko: /* Запуск из-под Eclipse */</p> <hr /> <div>=== Простой запуск ===<br /> Самый простой запуск:<br /> # убедиться, что установлена Java 8 (JRE достаточно);<br /> # установить из Eclipse MarketPlace плагин IvyDE.<br /> # поместить исходники be4 в любую папку;<br /> # сделать одно из следующих действий:<br /> #* скачать готовый Eclipse для Windows x64 с files.dote.ru (обычно это архив eclipse.zip в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation) и разархивировать в любую папку;<br /> #* скачать Eclipse для своей ОС и установить на него содержимое архива repository.zip (обычно он находится в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation).<br /> <br /> При запуске eclipse.exe спросит, откуда взять исходники be4, если не догадается об их местоположении.<br /> <br /> === Запуск из-под Eclipse ===<br /> Для компиляции необходимы<br /> # '''Java 8''' [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html отсюда],<br /> # '''Eclipse IDE for Java EE Developers''', Eclipse '''Luna SR2''' [http://www.eclipse.org/downloads/packages/release/luna/sr2 отсюда],<br /> # '''Наша версия Freemarker IDE''',<br /> # '''IvyDE''' - устанавливается из Eclipse MarketPlace,<br /> # Наш проект '''common'''.<br /> <br /> ----<br /> <br /> === Варианты установки Freemarker IDE ===<br /> ==== Вариант 1 (запуск без исходного кода Freemarker IDE). ====<br /> Установить содержимое \\files.dote.ru\pub2\_be4\Installation\freemarker.feature.zip<br /> # Заходим в... Help-&gt;Install New Software. Add...-&gt;Archive... выбрать архив, OK.<br /> # Снять галочку &quot;Group items by category&quot;, если не видно пунктов для установки.<br /> <br /> ==== Вариант 2 (для разработчиков Freemarker IDE). ====<br /> # Необходим репозиторий https://github.com/amaembo/jbosstools-freemarker.git<br /> # После скачивания репозитория нужно импортировать два проекта:<br /> #*- org.freemarker.core<br /> #*- org.jboss.ide.eclipse.freemarker. Остальные проекты можно не импортировать или просто закрыть.<br /> # Windows -&gt; Preferences; Plug-In Development -&gt; API Baselines; ввести произвольное имя, Reset, Finish, Apply, OK.<br /> <br /> === Настройки запуска: ===<br /> # Run-&gt;Debug Configurations..., выбрать Eclipse Application, нажать New launch configuration.<br /> # Выбрать каталог в Workspace data (лучше создать новый пустой, например, c:\projects\be4-workspace).<br /> # Execution environment -&gt; Java 1.8.<br /> # Вкладка Arguments Скопировать это значение в поле VM Arguments: '''-Dosgi.requiredJavaVersion=1.8 -Xms256m -Xmx768m -ea'''<br /> # Apply, Debug.</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T09:49:02Z

<p>Asko: /* Основные интерфейсы и классы API */</p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны по следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> Частью API также '''не''' являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты, описанные в разделе [[#REST API|REST API]].<br /> <br /> == Frontend ==<br /> &lt;big&gt;Компоненты BE5 на frontend - это React.js компоненты.&lt;/big&gt;<br /> <br /> Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод &lt;code&gt;define&lt;/code&gt;.<br /> <br /> import Component from 'components/component';<br /> <br /> define([ 'components/component' ], function(Component) {<br /> // use(Component)<br /> // ...<br /> return {};<br /> });<br /> <br /> Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную. <br /> <br /> Не всё, что находится в проекте be5-frontend, является частью API.<br /> <br /> === Основные части API ===<br /> <br /> * &lt;code&gt;be5&lt;/code&gt; - ядро frontend. Функции, являющиеся частью API:<br /> ** &lt;code&gt;be5.net.request: function(path, params, success, failure)&lt;/code&gt; - делает асинхронный POST запрос к ''вашему'' backend компоненту (&lt;code&gt;path&lt;/code&gt; - &lt;code&gt;componentId/any/path&lt;/code&gt;).<br /> ** &lt;code&gt;be5.registerAction: function(actionName, fn)&lt;/code&gt; - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.<br /> ** &lt;code&gt;be5.ui.registerDocumentType: function(type, creator)&lt;/code&gt; - регистрирует новый вид документа. Функция, переданная вторым параметром в &lt;code&gt;registerDocumentType&lt;/code&gt; обычно вызывает &lt;code&gt;React.createElement&lt;/code&gt; и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt; - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: &lt;code&gt;type&lt;/code&gt; и &lt;code&gt;value&lt;/code&gt;. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова &lt;code&gt;be5.ui.registerDocumentType&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.createDocument&lt;/code&gt; - похож на &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;, однако позволяет встраивать документы в произвольное место страницы. Полезно, если тип документа заранее неизвестен.<br /> ** &lt;code&gt;be5.load.css(path)&lt;/code&gt; - подгружает CSS динамически, это необходимо во frontend компонентах, которым нужен CSS. &lt;code&gt;path&lt;/code&gt; - путь к файлу CSS, например &lt;code&gt;css/menu.css&lt;/code&gt;.<br /> ** &lt;code&gt;be5.messages&lt;/code&gt; - объект с локализованными сообщениями (русский и английский язык).<br /> <br /> ==== Другой способ определения действий ====<br /> Вы также можете определить действие неявным способом не вызывая &lt;code&gt;be5.registerAction&lt;/code&gt;. Для этого создаётся файл с именем &lt;code&gt;/actions/yourAction.js&lt;/code&gt;, который определяет AMD модуль посредством метода &lt;code&gt;define&lt;/code&gt;. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом &lt;code&gt;be5.registerAction&lt;/code&gt;, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.<br /> <br /> === Компоненты ===<br /> &lt;big&gt;API React компонентов описывается в соответствующих файлах в &lt;code&gt;propTypes&lt;/code&gt; React компонентов.&lt;/big&gt;<br /> <br /> Компоненты, не указанные ниже, не являются частью API. По соглашениям именования мы сопоставляем имя компонента &lt;code&gt;ComponentName&lt;/code&gt; SystemJS модулю &lt;code&gt;component/componentName&lt;/code&gt;, который находится в файле &lt;code&gt;component/componentName.js&lt;/code&gt; (или &lt;code&gt;component/componentName.jsx&lt;/code&gt;, если для вашего проекта настроена компиляция JSX).<br /> <br /> ==== Be5Block ====<br /> Простая таблица внутри Bootstrap 4 Card.<br /> <br /> ==== Be5Form ====<br /> Простая форма внутри Bootstrap 4 Card.<br /> <br /> ==== Be5View ====<br /> Обобщённый компонент для таблиц, форм и статических страниц.<br /> <br /> ==== SimpleTable ====<br /> Простая таблица.<br /> <br /> ==== SimpleForm ====<br /> Простая форма.<br /> <br /> ==== Document ====<br /> Место для любого документа, в т.ч. формы или таблицы.<br /> <br /> == REST API ==<br /> Запросы отсылаются с телом &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;.<br /> <br /> === document ===<br /> Пример запроса (здесь указано содержимое тела запроса - на самом деле оно выглядит несколько иначе, поскольку кодируется в &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;):<br /> <br /> category: servers<br /> page: All records<br /> values:<br /> <br /> Пример таблицы:<br /> <br /> {<br /> &quot;type&quot;: &quot;table&quot;,<br /> &quot;value&quot;: {<br /> &quot;title&quot;: &quot;Servers: All records&quot;,<br /> &quot;category&quot;: &quot;servers&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;operations&quot;: [ {<br /> &quot;name&quot;: &quot;Edit&quot;,<br /> &quot;title&quot;: &quot;Edit&quot;,<br /> &quot;visibleWhen&quot;: &quot;anySelected&quot;,<br /> &quot;requiresConfirmation&quot;: false,<br /> &quot;isClientSide&quot;: false<br /> } ],<br /> &quot;selectable&quot;: true,<br /> &quot;columns&quot;: [ &quot;Edit&quot;, &quot;Provider&quot;, &quot;Location&quot;, &quot;Name&quot;, &quot;Address&quot;, &quot;Description&quot;, &quot;Products&quot;, &quot;Remote address&quot; ],<br /> &quot;rows&quot;: [ {<br /> &quot;id&quot;: &quot;1&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot; ]<br /> }, {<br /> &quot;id&quot;: &quot;3&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot; ]<br /> } ],<br /> &quot;length&quot;: 20,<br /> &quot;parameters&quot;: {},<br /> &quot;totalNumberOfRows&quot;: 20<br /> }<br /> }<br /> <br /> === document/count ===<br /> Запрос выглядит так же, как и у &lt;code&gt;document&lt;/code&gt;.<br /> <br /> Пример ответа:<br /> <br /> { &quot;value&quot;: 3 }<br /> <br /> === form ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> values:<br /> selectedRows:<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> &quot;type&quot;: &quot;form&quot;,<br /> &quot;value&quot;: {<br /> &quot;category&quot;: &quot;groups&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;action&quot;: &quot;Insert&quot;,<br /> &quot;title&quot;: &quot;Insert&quot;,<br /> &quot;selectedRows&quot;: &quot;&quot;,<br /> &quot;fields&quot;: [ {<br /> &quot;name&quot;: &quot;name&quot;,<br /> &quot;title&quot;: &quot;Name&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;language&quot;,<br /> &quot;title&quot;: &quot;Language&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;comboBox&quot;,<br /> &quot;options&quot;: [ {<br /> &quot;name&quot;: &quot;Afar&quot;,<br /> &quot;value&quot;: &quot;aa&quot;<br /> }, ..., {<br /> &quot;name&quot;: &quot;Zulu&quot;,<br /> &quot;value&quot;: &quot;zu&quot;<br /> } ],<br /> &quot;value&quot;: &quot;en&quot;<br /> }, {<br /> &quot;name&quot;: &quot;description&quot;,<br /> &quot;title&quot;: &quot;Description&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textArea&quot;,<br /> &quot;columns&quot;: 40,<br /> &quot;rows&quot;: 4,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;maxUsers&quot;,<br /> &quot;title&quot;: &quot;Max Users&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: true,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> } ],<br /> &quot;parameters&quot;: {},<br /> &quot;isViewParameters&quot;: false<br /> }<br /> <br /> === form/apply ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> selectedRows:<br /> values: [{&quot;name&quot;:&quot;name&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;language&quot;,&quot;value&quot;:&quot;en&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;description&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;maxUsers&quot;,&quot;value&quot;:&quot;5&quot;,&quot;required&quot;:false}]<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> type: &quot;formResult&quot;,<br /> value: {<br /> content: &quot;&quot;,<br /> redirect: &quot;table/groups/All records&quot;<br /> }<br /> }<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T09:20:22Z

<p>Asko: /* Backend */</p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны по следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> Частью API также являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты, описанные в разделе [[#REST API|REST API]].<br /> <br /> == Frontend ==<br /> &lt;big&gt;Компоненты BE5 на frontend - это React.js компоненты.&lt;/big&gt;<br /> <br /> Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод &lt;code&gt;define&lt;/code&gt;.<br /> <br /> import Component from 'components/component';<br /> <br /> define([ 'components/component' ], function(Component) {<br /> // use(Component)<br /> // ...<br /> return {};<br /> });<br /> <br /> Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную. <br /> <br /> Не всё, что находится в проекте be5-frontend, является частью API.<br /> <br /> === Основные части API ===<br /> <br /> * &lt;code&gt;be5&lt;/code&gt; - ядро frontend. Функции, являющиеся частью API:<br /> ** &lt;code&gt;be5.net.request: function(path, params, success, failure)&lt;/code&gt; - делает асинхронный POST запрос к ''вашему'' backend компоненту (&lt;code&gt;path&lt;/code&gt; - &lt;code&gt;componentId/any/path&lt;/code&gt;).<br /> ** &lt;code&gt;be5.registerAction: function(actionName, fn)&lt;/code&gt; - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.<br /> ** &lt;code&gt;be5.ui.registerDocumentType: function(type, creator)&lt;/code&gt; - регистрирует новый вид документа. Функция, переданная вторым параметром в &lt;code&gt;registerDocumentType&lt;/code&gt; обычно вызывает &lt;code&gt;React.createElement&lt;/code&gt; и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt; - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: &lt;code&gt;type&lt;/code&gt; и &lt;code&gt;value&lt;/code&gt;. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова &lt;code&gt;be5.ui.registerDocumentType&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.createDocument&lt;/code&gt; - похож на &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;, однако позволяет встраивать документы в произвольное место страницы. Полезно, если тип документа заранее неизвестен.<br /> ** &lt;code&gt;be5.load.css(path)&lt;/code&gt; - подгружает CSS динамически, это необходимо во frontend компонентах, которым нужен CSS. &lt;code&gt;path&lt;/code&gt; - путь к файлу CSS, например &lt;code&gt;css/menu.css&lt;/code&gt;.<br /> ** &lt;code&gt;be5.messages&lt;/code&gt; - объект с локализованными сообщениями (русский и английский язык).<br /> <br /> ==== Другой способ определения действий ====<br /> Вы также можете определить действие неявным способом не вызывая &lt;code&gt;be5.registerAction&lt;/code&gt;. Для этого создаётся файл с именем &lt;code&gt;/actions/yourAction.js&lt;/code&gt;, который определяет AMD модуль посредством метода &lt;code&gt;define&lt;/code&gt;. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом &lt;code&gt;be5.registerAction&lt;/code&gt;, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.<br /> <br /> === Компоненты ===<br /> &lt;big&gt;API React компонентов описывается в соответствующих файлах в &lt;code&gt;propTypes&lt;/code&gt; React компонентов.&lt;/big&gt;<br /> <br /> Компоненты, не указанные ниже, не являются частью API. По соглашениям именования мы сопоставляем имя компонента &lt;code&gt;ComponentName&lt;/code&gt; SystemJS модулю &lt;code&gt;component/componentName&lt;/code&gt;, который находится в файле &lt;code&gt;component/componentName.js&lt;/code&gt; (или &lt;code&gt;component/componentName.jsx&lt;/code&gt;, если для вашего проекта настроена компиляция JSX).<br /> <br /> ==== Be5Block ====<br /> Простая таблица внутри Bootstrap 4 Card.<br /> <br /> ==== Be5Form ====<br /> Простая форма внутри Bootstrap 4 Card.<br /> <br /> ==== Be5View ====<br /> Обобщённый компонент для таблиц, форм и статических страниц.<br /> <br /> ==== SimpleTable ====<br /> Простая таблица.<br /> <br /> ==== SimpleForm ====<br /> Простая форма.<br /> <br /> ==== Document ====<br /> Место для любого документа, в т.ч. формы или таблицы.<br /> <br /> == REST API ==<br /> Запросы отсылаются с телом &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;.<br /> <br /> === document ===<br /> Пример запроса (здесь указано содержимое тела запроса - на самом деле оно выглядит несколько иначе, поскольку кодируется в &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;):<br /> <br /> category: servers<br /> page: All records<br /> values:<br /> <br /> Пример таблицы:<br /> <br /> {<br /> &quot;type&quot;: &quot;table&quot;,<br /> &quot;value&quot;: {<br /> &quot;title&quot;: &quot;Servers: All records&quot;,<br /> &quot;category&quot;: &quot;servers&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;operations&quot;: [ {<br /> &quot;name&quot;: &quot;Edit&quot;,<br /> &quot;title&quot;: &quot;Edit&quot;,<br /> &quot;visibleWhen&quot;: &quot;anySelected&quot;,<br /> &quot;requiresConfirmation&quot;: false,<br /> &quot;isClientSide&quot;: false<br /> } ],<br /> &quot;selectable&quot;: true,<br /> &quot;columns&quot;: [ &quot;Edit&quot;, &quot;Provider&quot;, &quot;Location&quot;, &quot;Name&quot;, &quot;Address&quot;, &quot;Description&quot;, &quot;Products&quot;, &quot;Remote address&quot; ],<br /> &quot;rows&quot;: [ {<br /> &quot;id&quot;: &quot;1&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot; ]<br /> }, {<br /> &quot;id&quot;: &quot;3&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot; ]<br /> } ],<br /> &quot;length&quot;: 20,<br /> &quot;parameters&quot;: {},<br /> &quot;totalNumberOfRows&quot;: 20<br /> }<br /> }<br /> <br /> === document/count ===<br /> Запрос выглядит так же, как и у &lt;code&gt;document&lt;/code&gt;.<br /> <br /> Пример ответа:<br /> <br /> { &quot;value&quot;: 3 }<br /> <br /> === form ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> values:<br /> selectedRows:<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> &quot;type&quot;: &quot;form&quot;,<br /> &quot;value&quot;: {<br /> &quot;category&quot;: &quot;groups&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;action&quot;: &quot;Insert&quot;,<br /> &quot;title&quot;: &quot;Insert&quot;,<br /> &quot;selectedRows&quot;: &quot;&quot;,<br /> &quot;fields&quot;: [ {<br /> &quot;name&quot;: &quot;name&quot;,<br /> &quot;title&quot;: &quot;Name&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;language&quot;,<br /> &quot;title&quot;: &quot;Language&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;comboBox&quot;,<br /> &quot;options&quot;: [ {<br /> &quot;name&quot;: &quot;Afar&quot;,<br /> &quot;value&quot;: &quot;aa&quot;<br /> }, ..., {<br /> &quot;name&quot;: &quot;Zulu&quot;,<br /> &quot;value&quot;: &quot;zu&quot;<br /> } ],<br /> &quot;value&quot;: &quot;en&quot;<br /> }, {<br /> &quot;name&quot;: &quot;description&quot;,<br /> &quot;title&quot;: &quot;Description&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textArea&quot;,<br /> &quot;columns&quot;: 40,<br /> &quot;rows&quot;: 4,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;maxUsers&quot;,<br /> &quot;title&quot;: &quot;Max Users&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: true,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> } ],<br /> &quot;parameters&quot;: {},<br /> &quot;isViewParameters&quot;: false<br /> }<br /> <br /> === form/apply ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> selectedRows:<br /> values: [{&quot;name&quot;:&quot;name&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;language&quot;,&quot;value&quot;:&quot;en&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;description&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;maxUsers&quot;,&quot;value&quot;:&quot;5&quot;,&quot;required&quot;:false}]<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> type: &quot;formResult&quot;,<br /> value: {<br /> content: &quot;&quot;,<br /> redirect: &quot;table/groups/All records&quot;<br /> }<br /> }<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T09:14:32Z

<p>Asko: /* Компоненты */</p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> Частью API также являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты, описанные в разделе [[#REST API|REST API]].<br /> <br /> == Frontend ==<br /> &lt;big&gt;Компоненты BE5 на frontend - это React.js компоненты.&lt;/big&gt;<br /> <br /> Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод &lt;code&gt;define&lt;/code&gt;.<br /> <br /> import Component from 'components/component';<br /> <br /> define([ 'components/component' ], function(Component) {<br /> // use(Component)<br /> // ...<br /> return {};<br /> });<br /> <br /> Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную. <br /> <br /> Не всё, что находится в проекте be5-frontend, является частью API.<br /> <br /> === Основные части API ===<br /> <br /> * &lt;code&gt;be5&lt;/code&gt; - ядро frontend. Функции, являющиеся частью API:<br /> ** &lt;code&gt;be5.net.request: function(path, params, success, failure)&lt;/code&gt; - делает асинхронный POST запрос к ''вашему'' backend компоненту (&lt;code&gt;path&lt;/code&gt; - &lt;code&gt;componentId/any/path&lt;/code&gt;).<br /> ** &lt;code&gt;be5.registerAction: function(actionName, fn)&lt;/code&gt; - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.<br /> ** &lt;code&gt;be5.ui.registerDocumentType: function(type, creator)&lt;/code&gt; - регистрирует новый вид документа. Функция, переданная вторым параметром в &lt;code&gt;registerDocumentType&lt;/code&gt; обычно вызывает &lt;code&gt;React.createElement&lt;/code&gt; и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt; - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: &lt;code&gt;type&lt;/code&gt; и &lt;code&gt;value&lt;/code&gt;. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова &lt;code&gt;be5.ui.registerDocumentType&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.createDocument&lt;/code&gt; - похож на &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;, однако позволяет встраивать документы в произвольное место страницы. Полезно, если тип документа заранее неизвестен.<br /> ** &lt;code&gt;be5.load.css(path)&lt;/code&gt; - подгружает CSS динамически, это необходимо во frontend компонентах, которым нужен CSS. &lt;code&gt;path&lt;/code&gt; - путь к файлу CSS, например &lt;code&gt;css/menu.css&lt;/code&gt;.<br /> ** &lt;code&gt;be5.messages&lt;/code&gt; - объект с локализованными сообщениями (русский и английский язык).<br /> <br /> ==== Другой способ определения действий ====<br /> Вы также можете определить действие неявным способом не вызывая &lt;code&gt;be5.registerAction&lt;/code&gt;. Для этого создаётся файл с именем &lt;code&gt;/actions/yourAction.js&lt;/code&gt;, который определяет AMD модуль посредством метода &lt;code&gt;define&lt;/code&gt;. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом &lt;code&gt;be5.registerAction&lt;/code&gt;, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.<br /> <br /> === Компоненты ===<br /> &lt;big&gt;API React компонентов описывается в соответствующих файлах в &lt;code&gt;propTypes&lt;/code&gt; React компонентов.&lt;/big&gt;<br /> <br /> Компоненты, не указанные ниже, не являются частью API. По соглашениям именования мы сопоставляем имя компонента &lt;code&gt;ComponentName&lt;/code&gt; SystemJS модулю &lt;code&gt;component/componentName&lt;/code&gt;, который находится в файле &lt;code&gt;component/componentName.js&lt;/code&gt; (или &lt;code&gt;component/componentName.jsx&lt;/code&gt;, если для вашего проекта настроена компиляция JSX).<br /> <br /> ==== Be5Block ====<br /> Простая таблица внутри Bootstrap 4 Card.<br /> <br /> ==== Be5Form ====<br /> Простая форма внутри Bootstrap 4 Card.<br /> <br /> ==== Be5View ====<br /> Обобщённый компонент для таблиц, форм и статических страниц.<br /> <br /> ==== SimpleTable ====<br /> Простая таблица.<br /> <br /> ==== SimpleForm ====<br /> Простая форма.<br /> <br /> ==== Document ====<br /> Место для любого документа, в т.ч. формы или таблицы.<br /> <br /> == REST API ==<br /> Запросы отсылаются с телом &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;.<br /> <br /> === document ===<br /> Пример запроса (здесь указано содержимое тела запроса - на самом деле оно выглядит несколько иначе, поскольку кодируется в &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;):<br /> <br /> category: servers<br /> page: All records<br /> values:<br /> <br /> Пример таблицы:<br /> <br /> {<br /> &quot;type&quot;: &quot;table&quot;,<br /> &quot;value&quot;: {<br /> &quot;title&quot;: &quot;Servers: All records&quot;,<br /> &quot;category&quot;: &quot;servers&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;operations&quot;: [ {<br /> &quot;name&quot;: &quot;Edit&quot;,<br /> &quot;title&quot;: &quot;Edit&quot;,<br /> &quot;visibleWhen&quot;: &quot;anySelected&quot;,<br /> &quot;requiresConfirmation&quot;: false,<br /> &quot;isClientSide&quot;: false<br /> } ],<br /> &quot;selectable&quot;: true,<br /> &quot;columns&quot;: [ &quot;Edit&quot;, &quot;Provider&quot;, &quot;Location&quot;, &quot;Name&quot;, &quot;Address&quot;, &quot;Description&quot;, &quot;Products&quot;, &quot;Remote address&quot; ],<br /> &quot;rows&quot;: [ {<br /> &quot;id&quot;: &quot;1&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot; ]<br /> }, {<br /> &quot;id&quot;: &quot;3&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot; ]<br /> } ],<br /> &quot;length&quot;: 20,<br /> &quot;parameters&quot;: {},<br /> &quot;totalNumberOfRows&quot;: 20<br /> }<br /> }<br /> <br /> === document/count ===<br /> Запрос выглядит так же, как и у &lt;code&gt;document&lt;/code&gt;.<br /> <br /> Пример ответа:<br /> <br /> { &quot;value&quot;: 3 }<br /> <br /> === form ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> values:<br /> selectedRows:<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> &quot;type&quot;: &quot;form&quot;,<br /> &quot;value&quot;: {<br /> &quot;category&quot;: &quot;groups&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;action&quot;: &quot;Insert&quot;,<br /> &quot;title&quot;: &quot;Insert&quot;,<br /> &quot;selectedRows&quot;: &quot;&quot;,<br /> &quot;fields&quot;: [ {<br /> &quot;name&quot;: &quot;name&quot;,<br /> &quot;title&quot;: &quot;Name&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;language&quot;,<br /> &quot;title&quot;: &quot;Language&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;comboBox&quot;,<br /> &quot;options&quot;: [ {<br /> &quot;name&quot;: &quot;Afar&quot;,<br /> &quot;value&quot;: &quot;aa&quot;<br /> }, ..., {<br /> &quot;name&quot;: &quot;Zulu&quot;,<br /> &quot;value&quot;: &quot;zu&quot;<br /> } ],<br /> &quot;value&quot;: &quot;en&quot;<br /> }, {<br /> &quot;name&quot;: &quot;description&quot;,<br /> &quot;title&quot;: &quot;Description&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textArea&quot;,<br /> &quot;columns&quot;: 40,<br /> &quot;rows&quot;: 4,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;maxUsers&quot;,<br /> &quot;title&quot;: &quot;Max Users&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: true,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> } ],<br /> &quot;parameters&quot;: {},<br /> &quot;isViewParameters&quot;: false<br /> }<br /> <br /> === form/apply ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> selectedRows:<br /> values: [{&quot;name&quot;:&quot;name&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;language&quot;,&quot;value&quot;:&quot;en&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;description&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;maxUsers&quot;,&quot;value&quot;:&quot;5&quot;,&quot;required&quot;:false}]<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> type: &quot;formResult&quot;,<br /> value: {<br /> content: &quot;&quot;,<br /> redirect: &quot;table/groups/All records&quot;<br /> }<br /> }<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T09:13:38Z

<p>Asko: /* Frontend */</p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> Частью API также являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты, описанные в разделе [[#REST API|REST API]].<br /> <br /> == Frontend ==<br /> &lt;big&gt;Компоненты BE5 на frontend - это React.js компоненты.&lt;/big&gt;<br /> <br /> Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод &lt;code&gt;define&lt;/code&gt;.<br /> <br /> import Component from 'components/component';<br /> <br /> define([ 'components/component' ], function(Component) {<br /> // use(Component)<br /> // ...<br /> return {};<br /> });<br /> <br /> Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную. <br /> <br /> Не всё, что находится в проекте be5-frontend, является частью API.<br /> <br /> === Основные части API ===<br /> <br /> * &lt;code&gt;be5&lt;/code&gt; - ядро frontend. Функции, являющиеся частью API:<br /> ** &lt;code&gt;be5.net.request: function(path, params, success, failure)&lt;/code&gt; - делает асинхронный POST запрос к ''вашему'' backend компоненту (&lt;code&gt;path&lt;/code&gt; - &lt;code&gt;componentId/any/path&lt;/code&gt;).<br /> ** &lt;code&gt;be5.registerAction: function(actionName, fn)&lt;/code&gt; - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.<br /> ** &lt;code&gt;be5.ui.registerDocumentType: function(type, creator)&lt;/code&gt; - регистрирует новый вид документа. Функция, переданная вторым параметром в &lt;code&gt;registerDocumentType&lt;/code&gt; обычно вызывает &lt;code&gt;React.createElement&lt;/code&gt; и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt; - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: &lt;code&gt;type&lt;/code&gt; и &lt;code&gt;value&lt;/code&gt;. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова &lt;code&gt;be5.ui.registerDocumentType&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.createDocument&lt;/code&gt; - похож на &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;, однако позволяет встраивать документы в произвольное место страницы. Полезно, если тип документа заранее неизвестен.<br /> ** &lt;code&gt;be5.load.css(path)&lt;/code&gt; - подгружает CSS динамически, это необходимо во frontend компонентах, которым нужен CSS. &lt;code&gt;path&lt;/code&gt; - путь к файлу CSS, например &lt;code&gt;css/menu.css&lt;/code&gt;.<br /> ** &lt;code&gt;be5.messages&lt;/code&gt; - объект с локализованными сообщениями (русский и английский язык).<br /> <br /> ==== Другой способ определения действий ====<br /> Вы также можете определить действие неявным способом не вызывая &lt;code&gt;be5.registerAction&lt;/code&gt;. Для этого создаётся файл с именем &lt;code&gt;/actions/yourAction.js&lt;/code&gt;, который определяет AMD модуль посредством метода &lt;code&gt;define&lt;/code&gt;. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом &lt;code&gt;be5.registerAction&lt;/code&gt;, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.<br /> <br /> === Компоненты ===<br /> API React компонентов описывается в соответствующих файлах в &lt;code&gt;propTypes&lt;/code&gt; React компонентов. Компоненты, не указанные ниже, не являются частью API. По соглашениям именования мы сопоставляем имя компонента &lt;code&gt;ComponentName&lt;/code&gt; SystemJS модулю &lt;code&gt;component/componentName&lt;/code&gt;, который находится в файле &lt;code&gt;component/componentName.js&lt;/code&gt; (или &lt;code&gt;component/componentName.jsx&lt;/code&gt;, если для вашего проекта настроена компиляция JSX).<br /> <br /> ==== Be5Block ====<br /> Простая таблица внутри Bootstrap 4 Card.<br /> <br /> ==== Be5Form ====<br /> Простая форма внутри Bootstrap 4 Card.<br /> <br /> ==== Be5View ====<br /> Обобщённый компонент для таблиц, форм и статических страниц.<br /> <br /> ==== SimpleTable ====<br /> Простая таблица.<br /> <br /> ==== SimpleForm ====<br /> Простая форма.<br /> <br /> ==== Document ====<br /> Место для любого документа, в т.ч. формы или таблицы.<br /> <br /> == REST API ==<br /> Запросы отсылаются с телом &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;.<br /> <br /> === document ===<br /> Пример запроса (здесь указано содержимое тела запроса - на самом деле оно выглядит несколько иначе, поскольку кодируется в &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;):<br /> <br /> category: servers<br /> page: All records<br /> values:<br /> <br /> Пример таблицы:<br /> <br /> {<br /> &quot;type&quot;: &quot;table&quot;,<br /> &quot;value&quot;: {<br /> &quot;title&quot;: &quot;Servers: All records&quot;,<br /> &quot;category&quot;: &quot;servers&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;operations&quot;: [ {<br /> &quot;name&quot;: &quot;Edit&quot;,<br /> &quot;title&quot;: &quot;Edit&quot;,<br /> &quot;visibleWhen&quot;: &quot;anySelected&quot;,<br /> &quot;requiresConfirmation&quot;: false,<br /> &quot;isClientSide&quot;: false<br /> } ],<br /> &quot;selectable&quot;: true,<br /> &quot;columns&quot;: [ &quot;Edit&quot;, &quot;Provider&quot;, &quot;Location&quot;, &quot;Name&quot;, &quot;Address&quot;, &quot;Description&quot;, &quot;Products&quot;, &quot;Remote address&quot; ],<br /> &quot;rows&quot;: [ {<br /> &quot;id&quot;: &quot;1&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot; ]<br /> }, {<br /> &quot;id&quot;: &quot;3&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot; ]<br /> } ],<br /> &quot;length&quot;: 20,<br /> &quot;parameters&quot;: {},<br /> &quot;totalNumberOfRows&quot;: 20<br /> }<br /> }<br /> <br /> === document/count ===<br /> Запрос выглядит так же, как и у &lt;code&gt;document&lt;/code&gt;.<br /> <br /> Пример ответа:<br /> <br /> { &quot;value&quot;: 3 }<br /> <br /> === form ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> values:<br /> selectedRows:<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> &quot;type&quot;: &quot;form&quot;,<br /> &quot;value&quot;: {<br /> &quot;category&quot;: &quot;groups&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;action&quot;: &quot;Insert&quot;,<br /> &quot;title&quot;: &quot;Insert&quot;,<br /> &quot;selectedRows&quot;: &quot;&quot;,<br /> &quot;fields&quot;: [ {<br /> &quot;name&quot;: &quot;name&quot;,<br /> &quot;title&quot;: &quot;Name&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;language&quot;,<br /> &quot;title&quot;: &quot;Language&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;comboBox&quot;,<br /> &quot;options&quot;: [ {<br /> &quot;name&quot;: &quot;Afar&quot;,<br /> &quot;value&quot;: &quot;aa&quot;<br /> }, ..., {<br /> &quot;name&quot;: &quot;Zulu&quot;,<br /> &quot;value&quot;: &quot;zu&quot;<br /> } ],<br /> &quot;value&quot;: &quot;en&quot;<br /> }, {<br /> &quot;name&quot;: &quot;description&quot;,<br /> &quot;title&quot;: &quot;Description&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textArea&quot;,<br /> &quot;columns&quot;: 40,<br /> &quot;rows&quot;: 4,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;maxUsers&quot;,<br /> &quot;title&quot;: &quot;Max Users&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: true,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> } ],<br /> &quot;parameters&quot;: {},<br /> &quot;isViewParameters&quot;: false<br /> }<br /> <br /> === form/apply ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> selectedRows:<br /> values: [{&quot;name&quot;:&quot;name&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;language&quot;,&quot;value&quot;:&quot;en&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;description&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;maxUsers&quot;,&quot;value&quot;:&quot;5&quot;,&quot;required&quot;:false}]<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> type: &quot;formResult&quot;,<br /> value: {<br /> content: &quot;&quot;,<br /> redirect: &quot;table/groups/All records&quot;<br /> }<br /> }<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T08:14:54Z

<p>Asko: /* REST API */</p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> Частью API также являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты, описанные в разделе [[#REST API|REST API]].<br /> <br /> == Frontend ==<br /> &lt;big&gt;Компоненты BE5 на frontend - это React.js компоненты.&lt;/big&gt;<br /> <br /> Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод &lt;code&gt;define&lt;/code&gt;.<br /> <br /> import Component from 'components/component';<br /> <br /> define([ 'components/component' ], function(Component) {<br /> // use(Component)<br /> // ...<br /> return {};<br /> });<br /> <br /> Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную. <br /> <br /> Не всё, что находится в проекте be5-frontend, является частью API.<br /> <br /> === Основные части API ===<br /> <br /> * &lt;code&gt;be5&lt;/code&gt; - ядро frontend. Функции, являющиеся частью API:<br /> ** &lt;code&gt;be5.net.request: function(path, params, success, failure)&lt;/code&gt; - делает асинхронный POST запрос к ''вашему'' backend компоненту (&lt;code&gt;path&lt;/code&gt; - &lt;code&gt;componentId/any/path&lt;/code&gt;).<br /> ** &lt;code&gt;be5.registerAction: function(actionName, fn)&lt;/code&gt; - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.<br /> ** &lt;code&gt;be5.ui.registerDocumentType: function(type, creator)&lt;/code&gt; - регистрирует новый вид документа. Функция, переданная вторым параметром в &lt;code&gt;registerDocumentType&lt;/code&gt; обычно вызывает &lt;code&gt;React.createElement&lt;/code&gt; и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt; - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: &lt;code&gt;type&lt;/code&gt; и &lt;code&gt;value&lt;/code&gt;. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова &lt;code&gt;be5.ui.registerDocumentType&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.createDocument&lt;/code&gt; - похож на &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;, однако позволяет встраивать документы в произвольное место страницы. Полезно, если тип документа заранее неизвестен.<br /> ** &lt;code&gt;be5.load.css(path)&lt;/code&gt; - подгружает CSS динамически, это необходимо во frontend компонентах, которым нужен CSS. &lt;code&gt;path&lt;/code&gt; - путь к файлу CSS, например &lt;code&gt;css/menu.css&lt;/code&gt;.<br /> ** &lt;code&gt;be5.messages&lt;/code&gt; - объект с локализованными сообщениями (русский и английский язык).<br /> <br /> ==== Другой способ определения действий ====<br /> Вы также можете определить действие неявным способом не вызывая &lt;code&gt;be5.registerAction&lt;/code&gt;. Для этого создаётся файл с именем &lt;code&gt;/actions/yourAction.js&lt;/code&gt;, который определяет AMD модуль посредством метода &lt;code&gt;define&lt;/code&gt;. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом &lt;code&gt;be5.registerAction&lt;/code&gt;, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.<br /> <br /> == REST API ==<br /> Запросы отсылаются с телом &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;.<br /> <br /> === document ===<br /> Пример запроса (здесь указано содержимое тела запроса - на самом деле оно выглядит несколько иначе, поскольку кодируется в &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;):<br /> <br /> category: servers<br /> page: All records<br /> values:<br /> <br /> Пример таблицы:<br /> <br /> {<br /> &quot;type&quot;: &quot;table&quot;,<br /> &quot;value&quot;: {<br /> &quot;title&quot;: &quot;Servers: All records&quot;,<br /> &quot;category&quot;: &quot;servers&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;operations&quot;: [ {<br /> &quot;name&quot;: &quot;Edit&quot;,<br /> &quot;title&quot;: &quot;Edit&quot;,<br /> &quot;visibleWhen&quot;: &quot;anySelected&quot;,<br /> &quot;requiresConfirmation&quot;: false,<br /> &quot;isClientSide&quot;: false<br /> } ],<br /> &quot;selectable&quot;: true,<br /> &quot;columns&quot;: [ &quot;Edit&quot;, &quot;Provider&quot;, &quot;Location&quot;, &quot;Name&quot;, &quot;Address&quot;, &quot;Description&quot;, &quot;Products&quot;, &quot;Remote address&quot; ],<br /> &quot;rows&quot;: [ {<br /> &quot;id&quot;: &quot;1&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot; ]<br /> }, {<br /> &quot;id&quot;: &quot;3&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot; ]<br /> } ],<br /> &quot;length&quot;: 20,<br /> &quot;parameters&quot;: {},<br /> &quot;totalNumberOfRows&quot;: 20<br /> }<br /> }<br /> <br /> === document/count ===<br /> Запрос выглядит так же, как и у &lt;code&gt;document&lt;/code&gt;.<br /> <br /> Пример ответа:<br /> <br /> { &quot;value&quot;: 3 }<br /> <br /> === form ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> values:<br /> selectedRows:<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> &quot;type&quot;: &quot;form&quot;,<br /> &quot;value&quot;: {<br /> &quot;category&quot;: &quot;groups&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;action&quot;: &quot;Insert&quot;,<br /> &quot;title&quot;: &quot;Insert&quot;,<br /> &quot;selectedRows&quot;: &quot;&quot;,<br /> &quot;fields&quot;: [ {<br /> &quot;name&quot;: &quot;name&quot;,<br /> &quot;title&quot;: &quot;Name&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;language&quot;,<br /> &quot;title&quot;: &quot;Language&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;comboBox&quot;,<br /> &quot;options&quot;: [ {<br /> &quot;name&quot;: &quot;Afar&quot;,<br /> &quot;value&quot;: &quot;aa&quot;<br /> }, ..., {<br /> &quot;name&quot;: &quot;Zulu&quot;,<br /> &quot;value&quot;: &quot;zu&quot;<br /> } ],<br /> &quot;value&quot;: &quot;en&quot;<br /> }, {<br /> &quot;name&quot;: &quot;description&quot;,<br /> &quot;title&quot;: &quot;Description&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textArea&quot;,<br /> &quot;columns&quot;: 40,<br /> &quot;rows&quot;: 4,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;maxUsers&quot;,<br /> &quot;title&quot;: &quot;Max Users&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: true,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> } ],<br /> &quot;parameters&quot;: {},<br /> &quot;isViewParameters&quot;: false<br /> }<br /> <br /> === form/apply ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> selectedRows:<br /> values: [{&quot;name&quot;:&quot;name&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;language&quot;,&quot;value&quot;:&quot;en&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;description&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;maxUsers&quot;,&quot;value&quot;:&quot;5&quot;,&quot;required&quot;:false}]<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> type: &quot;formResult&quot;,<br /> value: {<br /> content: &quot;&quot;,<br /> redirect: &quot;table/groups/All records&quot;<br /> }<br /> }<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T08:14:21Z

<p>Asko: /* REST API */</p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> Частью API также являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты, описанные в разделе [[#REST API|REST API]].<br /> <br /> == Frontend ==<br /> &lt;big&gt;Компоненты BE5 на frontend - это React.js компоненты.&lt;/big&gt;<br /> <br /> Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод &lt;code&gt;define&lt;/code&gt;.<br /> <br /> import Component from 'components/component';<br /> <br /> define([ 'components/component' ], function(Component) {<br /> // use(Component)<br /> // ...<br /> return {};<br /> });<br /> <br /> Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную. <br /> <br /> Не всё, что находится в проекте be5-frontend, является частью API.<br /> <br /> === Основные части API ===<br /> <br /> * &lt;code&gt;be5&lt;/code&gt; - ядро frontend. Функции, являющиеся частью API:<br /> ** &lt;code&gt;be5.net.request: function(path, params, success, failure)&lt;/code&gt; - делает асинхронный POST запрос к ''вашему'' backend компоненту (&lt;code&gt;path&lt;/code&gt; - &lt;code&gt;componentId/any/path&lt;/code&gt;).<br /> ** &lt;code&gt;be5.registerAction: function(actionName, fn)&lt;/code&gt; - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.<br /> ** &lt;code&gt;be5.ui.registerDocumentType: function(type, creator)&lt;/code&gt; - регистрирует новый вид документа. Функция, переданная вторым параметром в &lt;code&gt;registerDocumentType&lt;/code&gt; обычно вызывает &lt;code&gt;React.createElement&lt;/code&gt; и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt; - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: &lt;code&gt;type&lt;/code&gt; и &lt;code&gt;value&lt;/code&gt;. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова &lt;code&gt;be5.ui.registerDocumentType&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.createDocument&lt;/code&gt; - похож на &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;, однако позволяет встраивать документы в произвольное место страницы. Полезно, если тип документа заранее неизвестен.<br /> ** &lt;code&gt;be5.load.css(path)&lt;/code&gt; - подгружает CSS динамически, это необходимо во frontend компонентах, которым нужен CSS. &lt;code&gt;path&lt;/code&gt; - путь к файлу CSS, например &lt;code&gt;css/menu.css&lt;/code&gt;.<br /> ** &lt;code&gt;be5.messages&lt;/code&gt; - объект с локализованными сообщениями (русский и английский язык).<br /> <br /> ==== Другой способ определения действий ====<br /> Вы также можете определить действие неявным способом не вызывая &lt;code&gt;be5.registerAction&lt;/code&gt;. Для этого создаётся файл с именем &lt;code&gt;/actions/yourAction.js&lt;/code&gt;, который определяет AMD модуль посредством метода &lt;code&gt;define&lt;/code&gt;. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом &lt;code&gt;be5.registerAction&lt;/code&gt;, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.<br /> <br /> == REST API ==<br /> Запросы отсылаются в телом &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;.<br /> <br /> === document ===<br /> Пример запроса (здесь указано содержимое тела запроса - на самом деле оно выглядит несколько иначе, поскольку кодируется в &lt;code&gt;application/x-www-form-urlencoded&lt;/code&gt;):<br /> <br /> category: servers<br /> page: All records<br /> values:<br /> <br /> Пример таблицы:<br /> <br /> {<br /> &quot;type&quot;: &quot;table&quot;,<br /> &quot;value&quot;: {<br /> &quot;title&quot;: &quot;Servers: All records&quot;,<br /> &quot;category&quot;: &quot;servers&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;operations&quot;: [ {<br /> &quot;name&quot;: &quot;Edit&quot;,<br /> &quot;title&quot;: &quot;Edit&quot;,<br /> &quot;visibleWhen&quot;: &quot;anySelected&quot;,<br /> &quot;requiresConfirmation&quot;: false,<br /> &quot;isClientSide&quot;: false<br /> } ],<br /> &quot;selectable&quot;: true,<br /> &quot;columns&quot;: [ &quot;Edit&quot;, &quot;Provider&quot;, &quot;Location&quot;, &quot;Name&quot;, &quot;Address&quot;, &quot;Description&quot;, &quot;Products&quot;, &quot;Remote address&quot; ],<br /> &quot;rows&quot;: [ {<br /> &quot;id&quot;: &quot;1&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot; ]<br /> }, {<br /> &quot;id&quot;: &quot;3&quot;,<br /> &quot;cells&quot;: [ &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;html&quot;, &quot;html&quot;, &quot;html&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot; ]<br /> } ],<br /> &quot;length&quot;: 20,<br /> &quot;parameters&quot;: {},<br /> &quot;totalNumberOfRows&quot;: 20<br /> }<br /> }<br /> <br /> === document/count ===<br /> Запрос выглядит так же, как и у &lt;code&gt;document&lt;/code&gt;.<br /> <br /> Пример ответа:<br /> <br /> { &quot;value&quot;: 3 }<br /> <br /> === form ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> values:<br /> selectedRows:<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> &quot;type&quot;: &quot;form&quot;,<br /> &quot;value&quot;: {<br /> &quot;category&quot;: &quot;groups&quot;,<br /> &quot;page&quot;: &quot;All records&quot;,<br /> &quot;action&quot;: &quot;Insert&quot;,<br /> &quot;title&quot;: &quot;Insert&quot;,<br /> &quot;selectedRows&quot;: &quot;&quot;,<br /> &quot;fields&quot;: [ {<br /> &quot;name&quot;: &quot;name&quot;,<br /> &quot;title&quot;: &quot;Name&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;language&quot;,<br /> &quot;title&quot;: &quot;Language&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;comboBox&quot;,<br /> &quot;options&quot;: [ {<br /> &quot;name&quot;: &quot;Afar&quot;,<br /> &quot;value&quot;: &quot;aa&quot;<br /> }, ..., {<br /> &quot;name&quot;: &quot;Zulu&quot;,<br /> &quot;value&quot;: &quot;zu&quot;<br /> } ],<br /> &quot;value&quot;: &quot;en&quot;<br /> }, {<br /> &quot;name&quot;: &quot;description&quot;,<br /> &quot;title&quot;: &quot;Description&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: false,<br /> &quot;type&quot;: &quot;textArea&quot;,<br /> &quot;columns&quot;: 40,<br /> &quot;rows&quot;: 4,<br /> &quot;value&quot;: &quot;&quot;<br /> }, {<br /> &quot;name&quot;: &quot;maxUsers&quot;,<br /> &quot;title&quot;: &quot;Max Users&quot;,<br /> &quot;isReadOnly&quot;: false,<br /> &quot;canBeNull&quot;: true,<br /> &quot;type&quot;: &quot;textInput&quot;,<br /> &quot;value&quot;: &quot;&quot;<br /> } ],<br /> &quot;parameters&quot;: {},<br /> &quot;isViewParameters&quot;: false<br /> }<br /> <br /> === form/apply ===<br /> Пример запроса:<br /> <br /> category: groups<br /> page: All records<br /> action: Insert<br /> selectedRows:<br /> values: [{&quot;name&quot;:&quot;name&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;language&quot;,&quot;value&quot;:&quot;en&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;description&quot;,&quot;value&quot;:&quot;a&quot;,&quot;required&quot;:true},{&quot;name&quot;:&quot;maxUsers&quot;,&quot;value&quot;:&quot;5&quot;,&quot;required&quot;:false}]<br /> isViewParameters: false<br /> <br /> Пример ответа:<br /> <br /> {<br /> type: &quot;formResult&quot;,<br /> value: {<br /> content: &quot;&quot;,<br /> redirect: &quot;table/groups/All records&quot;<br /> }<br /> }<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T07:36:36Z

<p>Asko: /* Основные интерфейсы и классы API */</p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> Частью API также являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты, описанные в разделе [[#REST API|REST API]].<br /> <br /> == Frontend ==<br /> &lt;big&gt;Компоненты BE5 на frontend - это React.js компоненты.&lt;/big&gt;<br /> <br /> Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод &lt;code&gt;define&lt;/code&gt;.<br /> <br /> import Component from 'components/component';<br /> <br /> define([ 'components/component' ], function(Component) {<br /> // use(Component)<br /> // ...<br /> return {};<br /> });<br /> <br /> Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную. <br /> <br /> Не всё, что находится в проекте be5-frontend, является частью API.<br /> <br /> === Основные части API ===<br /> <br /> * &lt;code&gt;be5&lt;/code&gt; - ядро frontend. Функции, являющиеся частью API:<br /> ** &lt;code&gt;be5.net.request: function(path, params, success, failure)&lt;/code&gt; - делает асинхронный POST запрос к ''вашему'' backend компоненту (&lt;code&gt;path&lt;/code&gt; - &lt;code&gt;componentId/any/path&lt;/code&gt;).<br /> ** &lt;code&gt;be5.registerAction: function(actionName, fn)&lt;/code&gt; - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.<br /> ** &lt;code&gt;be5.ui.registerDocumentType: function(type, creator)&lt;/code&gt; - регистрирует новый вид документа. Функция, переданная вторым параметром в &lt;code&gt;registerDocumentType&lt;/code&gt; обычно вызывает &lt;code&gt;React.createElement&lt;/code&gt; и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt; - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: &lt;code&gt;type&lt;/code&gt; и &lt;code&gt;value&lt;/code&gt;. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова &lt;code&gt;be5.ui.registerDocumentType&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.createDocument&lt;/code&gt; - похож на &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;, однако позволяет встраивать документы в произвольное место страницы. Полезно, если тип документа заранее неизвестен.<br /> ** &lt;code&gt;be5.load.css(path)&lt;/code&gt; - подгружает CSS динамически, это необходимо во frontend компонентах, которым нужен CSS. &lt;code&gt;path&lt;/code&gt; - путь к файлу CSS, например &lt;code&gt;css/menu.css&lt;/code&gt;.<br /> ** &lt;code&gt;be5.messages&lt;/code&gt; - объект с локализованными сообщениями (русский и английский язык).<br /> <br /> ==== Другой способ определения действий ====<br /> Вы также можете определить действие неявным способом не вызывая &lt;code&gt;be5.registerAction&lt;/code&gt;. Для этого создаётся файл с именем &lt;code&gt;/actions/yourAction.js&lt;/code&gt;, который определяет AMD модуль посредством метода &lt;code&gt;define&lt;/code&gt;. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом &lt;code&gt;be5.registerAction&lt;/code&gt;, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.<br /> <br /> == REST API ==<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T07:35:32Z

<p>Asko: /* Основные интерфейсы и классы API */</p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> Частью API также являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты, описанные в разделе [[#Rest API|REST API]].<br /> <br /> == Frontend ==<br /> &lt;big&gt;Компоненты BE5 на frontend - это React.js компоненты.&lt;/big&gt;<br /> <br /> Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод &lt;code&gt;define&lt;/code&gt;.<br /> <br /> import Component from 'components/component';<br /> <br /> define([ 'components/component' ], function(Component) {<br /> // use(Component)<br /> // ...<br /> return {};<br /> });<br /> <br /> Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную. <br /> <br /> Не всё, что находится в проекте be5-frontend, является частью API.<br /> <br /> === Основные части API ===<br /> <br /> * &lt;code&gt;be5&lt;/code&gt; - ядро frontend. Функции, являющиеся частью API:<br /> ** &lt;code&gt;be5.net.request: function(path, params, success, failure)&lt;/code&gt; - делает асинхронный POST запрос к ''вашему'' backend компоненту (&lt;code&gt;path&lt;/code&gt; - &lt;code&gt;componentId/any/path&lt;/code&gt;).<br /> ** &lt;code&gt;be5.registerAction: function(actionName, fn)&lt;/code&gt; - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.<br /> ** &lt;code&gt;be5.ui.registerDocumentType: function(type, creator)&lt;/code&gt; - регистрирует новый вид документа. Функция, переданная вторым параметром в &lt;code&gt;registerDocumentType&lt;/code&gt; обычно вызывает &lt;code&gt;React.createElement&lt;/code&gt; и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt; - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: &lt;code&gt;type&lt;/code&gt; и &lt;code&gt;value&lt;/code&gt;. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова &lt;code&gt;be5.ui.registerDocumentType&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.createDocument&lt;/code&gt; - похож на &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;, однако позволяет встраивать документы в произвольное место страницы. Полезно, если тип документа заранее неизвестен.<br /> ** &lt;code&gt;be5.load.css(path)&lt;/code&gt; - подгружает CSS динамически, это необходимо во frontend компонентах, которым нужен CSS. &lt;code&gt;path&lt;/code&gt; - путь к файлу CSS, например &lt;code&gt;css/menu.css&lt;/code&gt;.<br /> ** &lt;code&gt;be5.messages&lt;/code&gt; - объект с локализованными сообщениями (русский и английский язык).<br /> <br /> ==== Другой способ определения действий ====<br /> Вы также можете определить действие неявным способом не вызывая &lt;code&gt;be5.registerAction&lt;/code&gt;. Для этого создаётся файл с именем &lt;code&gt;/actions/yourAction.js&lt;/code&gt;, который определяет AMD модуль посредством метода &lt;code&gt;define&lt;/code&gt;. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом &lt;code&gt;be5.registerAction&lt;/code&gt;, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.<br /> <br /> == REST API ==<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T07:05:12Z

<p>Asko: /* Основные части API */</p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> Частью API также являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты &lt;code&gt;document&lt;/code&gt; и &lt;code&gt;form&lt;/code&gt;.<br /> <br /> == Frontend ==<br /> &lt;big&gt;Компоненты BE5 на frontend - это React.js компоненты.&lt;/big&gt;<br /> <br /> Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод &lt;code&gt;define&lt;/code&gt;.<br /> <br /> import Component from 'components/component';<br /> <br /> define([ 'components/component' ], function(Component) {<br /> // use(Component)<br /> // ...<br /> return {};<br /> });<br /> <br /> Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную. <br /> <br /> Не всё, что находится в проекте be5-frontend, является частью API.<br /> <br /> === Основные части API ===<br /> <br /> * &lt;code&gt;be5&lt;/code&gt; - ядро frontend. Функции, являющиеся частью API:<br /> ** &lt;code&gt;be5.net.request: function(path, params, success, failure)&lt;/code&gt; - делает асинхронный POST запрос к ''вашему'' backend компоненту (&lt;code&gt;path&lt;/code&gt; - &lt;code&gt;componentId/any/path&lt;/code&gt;).<br /> ** &lt;code&gt;be5.registerAction: function(actionName, fn)&lt;/code&gt; - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.<br /> ** &lt;code&gt;be5.ui.registerDocumentType: function(type, creator)&lt;/code&gt; - регистрирует новый вид документа. Функция, переданная вторым параметром в &lt;code&gt;registerDocumentType&lt;/code&gt; обычно вызывает &lt;code&gt;React.createElement&lt;/code&gt; и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt; - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: &lt;code&gt;type&lt;/code&gt; и &lt;code&gt;value&lt;/code&gt;. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова &lt;code&gt;be5.ui.registerDocumentType&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.createDocument&lt;/code&gt; - похож на &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;, однако позволяет встраивать документы в произвольное место страницы. Полезно, если тип документа заранее неизвестен.<br /> ** &lt;code&gt;be5.load.css(path)&lt;/code&gt; - подгружает CSS динамически, это необходимо во frontend компонентах, которым нужен CSS. &lt;code&gt;path&lt;/code&gt; - путь к файлу CSS, например &lt;code&gt;css/menu.css&lt;/code&gt;.<br /> ** &lt;code&gt;be5.messages&lt;/code&gt; - объект с локализованными сообщениями (русский и английский язык).<br /> <br /> ==== Другой способ определения действий ====<br /> Вы также можете определить действие неявным способом не вызывая &lt;code&gt;be5.registerAction&lt;/code&gt;. Для этого создаётся файл с именем &lt;code&gt;/actions/yourAction.js&lt;/code&gt;, который определяет AMD модуль посредством метода &lt;code&gt;define&lt;/code&gt;. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом &lt;code&gt;be5.registerAction&lt;/code&gt;, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.<br /> <br /> == REST API ==<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T06:56:08Z

<p>Asko: </p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> Частью API также являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты &lt;code&gt;document&lt;/code&gt; и &lt;code&gt;form&lt;/code&gt;.<br /> <br /> == Frontend ==<br /> &lt;big&gt;Компоненты BE5 на frontend - это React.js компоненты.&lt;/big&gt;<br /> <br /> Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод &lt;code&gt;define&lt;/code&gt;.<br /> <br /> import Component from 'components/component';<br /> <br /> define([ 'components/component' ], function(Component) {<br /> // use(Component)<br /> // ...<br /> return {};<br /> });<br /> <br /> Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную. <br /> <br /> Не всё, что находится в проекте be5-frontend, является частью API.<br /> <br /> === Основные части API ===<br /> <br /> * &lt;code&gt;be5&lt;/code&gt; - ядро frontend. Функции, являющиеся частью API:<br /> ** &lt;code&gt;be5.net.request: function(path, params, success, failure)&lt;/code&gt; - делает асинхронный POST запрос к ''вашему'' backend компоненту (&lt;code&gt;path&lt;/code&gt; - &lt;code&gt;componentId/any/path&lt;/code&gt;).<br /> ** &lt;code&gt;be5.registerAction: function(actionName, fn)&lt;/code&gt; - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.<br /> ** &lt;code&gt;be5.ui.registerDocumentType: function(type, creator)&lt;/code&gt; - регистрирует новый вид документа. Функция, переданная вторым параметром в &lt;code&gt;registerDocumentType&lt;/code&gt; обычно вызывает &lt;code&gt;React.createElement&lt;/code&gt; и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt;.<br /> ** &lt;code&gt;be5.ui.recreateDocument&lt;/code&gt; - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: &lt;code&gt;type&lt;/code&gt; и &lt;code&gt;value&lt;/code&gt;. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова &lt;code&gt;be5.ui.registerDocumentType&lt;/code&gt;.<br /> <br /> ==== Другой способ определения действий ====<br /> Вы также можете определить действие неявным способом не вызывая &lt;code&gt;be5.registerAction&lt;/code&gt;. Для этого создаётся файл с именем &lt;code&gt;/actions/yourAction.js&lt;/code&gt;, который определяет AMD модуль посредством метода &lt;code&gt;define&lt;/code&gt;. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом &lt;code&gt;be5.registerAction&lt;/code&gt;, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.<br /> <br /> == REST API ==<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5_API 2015-11-25T05:46:06Z

<p>Asko: Новая страница: «== Backend == &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big…»</p> <hr /> <div>== Backend ==<br /> &lt;big&gt;BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через &lt;code&gt;plugin.xml&lt;/code&gt;.&lt;/big&gt;<br /> <br /> При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест &lt;code&gt;META-INF/MANIFEST.MF&lt;/code&gt;. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;, поэтому его необходимо указать в манифесте.<br /> <br /> Помимо этого в структуру BeanExplorer5 проекта входит &lt;code&gt;plugin.xml&lt;/code&gt;, в котором возможно объявлять свои компоненты, используя точку расширения &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt;, которая объявлена в бандле &lt;code&gt;com.beanexplorer.be5&lt;/code&gt;. Пример объявления компонента:<br /> <br /> &lt;extension point=&quot;com.beanexplorer.be5.component&quot;&gt;<br /> ...<br /> &lt;component<br /> class=&quot;com.beanexplorer.enterprise.components.Menu&quot;<br /> id=&quot;menu&quot;<br /> name=&quot;Menu&quot;&gt;<br /> &lt;/component&gt;<br /> <br /> Указанный класс должен реализовывать интерфейс &lt;code&gt;Component&lt;/code&gt;:<br /> <br /> package com.beanexplorer.enterprise.components;<br /> <br /> public interface Component {<br /> void generate(ComponentParameters parameters);<br /> }<br /> <br /> &lt;code&gt;com.beanexplorer.be5.component&lt;/code&gt; - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны следующим URL:<br /> <br /> //domain/app/main/:componentId<br /> //domain/app/main/:componentId/:any/:path<br /> <br /> Например:<br /> <br /> http://localhost:8080/biostore_be5/main/menu<br /> http://localhost:8080/biostore_be5/main/menu/withIds<br /> <br /> При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (&lt;code&gt;:any/:path&lt;/code&gt;), нужно вызвать метод &lt;code&gt;parameters.getRequestUri()&lt;/code&gt;. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.<br /> <br /> === Основные интерфейсы и классы API ===<br /> <br /> * &lt;code&gt;Component&lt;/code&gt; - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:<br /> ** &lt;code&gt;JsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.<br /> ** &lt;code&gt;NetSfJsonComponent&lt;/code&gt; - при наследовании этого класса необходимо только реализовать один метод, возвращающий &lt;code&gt;net.sf.json.JSONObject&lt;/code&gt;.<br /> * &lt;code&gt;ComponentParameters&lt;/code&gt; - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели, либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:<br /> ** &lt;code&gt;Project&lt;/code&gt; - BE4 проект.<br /> ** &lt;code&gt;Meta&lt;/code&gt; - полезные методы для работы с BE4 проектом.<br /> ** &lt;code&gt;UserService&lt;/code&gt; - работа с сессиями, ролями, выбором языка.<br /> ** &lt;code&gt;ResponseService&lt;/code&gt; - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).<br /> ** &lt;code&gt;HttpServletRequest&lt;/code&gt; и &lt;code&gt;HttpServletResponse&lt;/code&gt; - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно &lt;code&gt;ResponseService&lt;/code&gt;.<br /> <br /> &lt;big&gt;Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.&lt;/big&gt;<br /> <br /> &lt;code&gt;&lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/%D0%97%D0%B0%D0%B3%D0%BB%D0%B0%D0%B2%D0%BD%D0%B0%D1%8F_%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0 2015-11-25T04:32:51Z

<p>Asko: /* BeanExplorer5 */</p> <hr /> <div>=== BeanExplorer4 ===<br /> * [[BeanExplorer4]]<br /> ** [[Для разработчиков BE4]]<br /> * [[Компиляция и запуск BeanExplorer4]]<br /> * [[Использование ant]]<br /> * [[Поддержка СУБД]]<br /> * [[Типы колонок]]<br /> * [[Структура проекта]]<br /> * [[Usecases|Usecases с картиночками]]<br /> * [[JavaScript Debugger]]<br /> * [[Extras]]<br /> * [[Entity template|Шаблоны для сущностей]]<br /> <br /> === Freemarker ===<br /> * [[Freemarker]]<br /> * [[Встроенные функции]]<br /> * [[Макросы]]<br /> * [[Объекты]]<br /> * [[Пользовательские макросы]]<br /> * [[Создание своих макросов]]<br /> * [[Built-ins]]<br /> <br /> === BeanExplorer5 ===<br /> * [[:Category:BeanExplorer5|Категория BeanExplorer5]]<br /> * [[BeanExplorer5|BeanExplorer5]]<br /> * [[BeanExplorer5 API|BeanExplorer5 API]]<br /> * [[BE-SQL|SQL-диалект BeanExplorer5]]<br /> ----<br /> <br /> === Внешние ссылки ===<br /> * BeanExplorer4 на Edge Wiki [https://sites.google.com/a/developmentontheedge.com/wiki/home/proektnaadokumentacia/beanexplorer4]<br /> ----<br /> Количество статей в вики: '''[[:Special:Statistics|{{NUMBEROFARTICLES}}]]'''.</div>

Asko http://wiki.dote.ru/index.php/%D0%97%D0%B0%D0%B3%D0%BB%D0%B0%D0%B2%D0%BD%D0%B0%D1%8F_%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0 2015-11-25T04:32:37Z

<p>Asko: /* BeanExplorer5 */</p> <hr /> <div>=== BeanExplorer4 ===<br /> * [[BeanExplorer4]]<br /> ** [[Для разработчиков BE4]]<br /> * [[Компиляция и запуск BeanExplorer4]]<br /> * [[Использование ant]]<br /> * [[Поддержка СУБД]]<br /> * [[Типы колонок]]<br /> * [[Структура проекта]]<br /> * [[Usecases|Usecases с картиночками]]<br /> * [[JavaScript Debugger]]<br /> * [[Extras]]<br /> * [[Entity template|Шаблоны для сущностей]]<br /> <br /> === Freemarker ===<br /> * [[Freemarker]]<br /> * [[Встроенные функции]]<br /> * [[Макросы]]<br /> * [[Объекты]]<br /> * [[Пользовательские макросы]]<br /> * [[Создание своих макросов]]<br /> * [[Built-ins]]<br /> <br /> === BeanExplorer5 ===<br /> * [[:Category:BeanExplorer5|Категория BeanExplorer5]]<br /> * [[BeanExplorer5|BeanExplorer5]]<br /> * [[BE-SQL|SQL-диалект BeanExplorer5]]<br /> * [[BeanExplorer5 API|BeanExplorer5 API]]<br /> ----<br /> <br /> === Внешние ссылки ===<br /> * BeanExplorer4 на Edge Wiki [https://sites.google.com/a/developmentontheedge.com/wiki/home/proektnaadokumentacia/beanexplorer4]<br /> ----<br /> Количество статей в вики: '''[[:Special:Statistics|{{NUMBEROFARTICLES}}]]'''.</div>

Asko http://wiki.dote.ru/index.php/%D0%97%D0%B0%D0%B3%D0%BB%D0%B0%D0%B2%D0%BD%D0%B0%D1%8F_%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0 2015-11-25T04:31:34Z

<p>Asko: /* BeanExplorer5 */</p> <hr /> <div>=== BeanExplorer4 ===<br /> * [[BeanExplorer4]]<br /> ** [[Для разработчиков BE4]]<br /> * [[Компиляция и запуск BeanExplorer4]]<br /> * [[Использование ant]]<br /> * [[Поддержка СУБД]]<br /> * [[Типы колонок]]<br /> * [[Структура проекта]]<br /> * [[Usecases|Usecases с картиночками]]<br /> * [[JavaScript Debugger]]<br /> * [[Extras]]<br /> * [[Entity template|Шаблоны для сущностей]]<br /> <br /> === Freemarker ===<br /> * [[Freemarker]]<br /> * [[Встроенные функции]]<br /> * [[Макросы]]<br /> * [[Объекты]]<br /> * [[Пользовательские макросы]]<br /> * [[Создание своих макросов]]<br /> * [[Built-ins]]<br /> <br /> === BeanExplorer5 ===<br /> * [[:Category:BeanExplorer5|Категория BeanExplorer5]]<br /> * [[BeanExplorer5|BeanExplorer5]]<br /> * [[BE-SQL|SQL-диалект BeanExplorer5]]<br /> * [[Компоненты BeanExplorer5|Компоненты BeanExplorer5]]<br /> ----<br /> <br /> === Внешние ссылки ===<br /> * BeanExplorer4 на Edge Wiki [https://sites.google.com/a/developmentontheedge.com/wiki/home/proektnaadokumentacia/beanexplorer4]<br /> ----<br /> Количество статей в вики: '''[[:Special:Statistics|{{NUMBEROFARTICLES}}]]'''.</div>

Asko http://wiki.dote.ru/index.php/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_BeanExplorer5_%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B0 2015-11-23T12:14:36Z

<p>Asko: </p> <hr /> <div>&lt;big&gt;Для сборки BeanExplorer5 проекта необходимо сначала подготовить BeanExplorer5 для сборки.&lt;/big&gt;<br /> <br /> == Подготовка инструментов ==<br /> * Необходим Ant. Для установки под Windows необходимо скачать Ant с [http://ant.apache.org/ официального сайта].<br /> * Необходим NPM. Для установки под Windows необходимо скачать Node.js с [https://nodejs.org/en/ официального сайта]. Мы используем 4 версию.<br /> * Необходим Gulp. &lt;code&gt;npm install --global gulp&lt;/code&gt;.<br /> <br /> == Подготовка BeanExplorer5 ==<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;ant prepareworkspace&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5/be5-frontend&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;, затем &lt;code&gt;gulp&lt;/code&gt;.<br /> <br /> == Работа с проектом ==<br /> * При первой сборке вызывается &lt;code&gt;ant be5.deploy&lt;/code&gt; в папке проекта.<br /> * При изменении frontend проекта вызывать &lt;code&gt;ant be5.frontend&lt;/code&gt; в папке проекта.<br /> * Не предусмотрено Ant цели для вызова при изменении backend кода.<br /> * Если вы редактируете &lt;code&gt;be5-frontend&lt;/code&gt;, то необходимо вызвать &lt;code&gt;gulp watch&lt;/code&gt; и ''помимо этого'' после редактирования вызывать &lt;code&gt;ant be5.frontend&lt;/code&gt; из папки BeanExplorer5 проекта.<br /> <br /> == При создании проекта ==<br /> Пример frontend проекта находится в &lt;code&gt;be5/be5-demo&lt;/code&gt;, он содержит пример настройки Gulp для инкрементальной сборки.<br /> <br /> Пример объявления целей be5.deploy и be5.frontend:<br /> <br /> &lt;code&gt;<br /> &lt;target name=&quot;be5.deploy&quot; depends=&quot;prepare&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;compileapp&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;modules&quot; value=&quot;${MODULES}&quot; /&gt;<br /> &lt;property name=&quot;usedatasource&quot; value=&quot;true&quot; /&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;property name=&quot;appencoding&quot; value=&quot;UTF-8&quot; /&gt;<br /> &lt;property name=&quot;SRCDIR&quot; value=&quot;${appabsolutepath}/src&quot; /&gt;<br /> &lt;property name=&quot;PROJECT_SOURCE&quot; value=&quot;${PROJECT_SOURCE}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;ant antfile=&quot;${COMMONDIR}/makefiles/be_webxml.xml&quot; target=&quot;install_context&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;tomcat&quot;&gt;<br /> &lt;available property=&quot;tomcat.is.installed&quot; file=&quot;${TOMCAT_HOME}/webapps&quot; type=&quot;dir&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;be5.frontend&quot; depends=&quot;tomcat,check_for_tomcat&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;fastfrontend&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;/target&gt;<br /> &lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_BeanExplorer5_%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B0 2015-11-23T12:06:37Z

<p>Asko: </p> <hr /> <div>&lt;big&gt;Для сборки BeanExplorer5 проекта необходимо сначала подготовить BeanExplorer5 для сборки.&lt;/big&gt;<br /> <br /> == Подготовка BeanExplorer5 ==<br /> * Необходим Ant. Для установки под Windows необходимо скачать Ant с [http://ant.apache.org/ официального сайта].<br /> * Необходим NPM. Для установки под Windows необходимо скачать Node.js с [https://nodejs.org/en/ официального сайта]. Мы используем 4 версию.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;ant prepareworkspace&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5/be5-frontend&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;, затем &lt;code&gt;gulp&lt;/code&gt;.<br /> <br /> == Работа с проектом ==<br /> * При первой сборке вызывается &lt;code&gt;ant be5.deploy&lt;/code&gt; в папке проекта.<br /> * При изменении frontend проекта вызывать &lt;code&gt;ant be5.frontend&lt;/code&gt; в папке проекта.<br /> * Не предусмотрено Ant цели для вызова при изменении backend кода.<br /> * Если вы редактируете &lt;code&gt;be5-frontend&lt;/code&gt;, то необходимо вызвать &lt;code&gt;gulp watch&lt;/code&gt; и ''помимо этого'' после редактирования вызывать &lt;code&gt;ant be5.frontend&lt;/code&gt; из папки BeanExplorer5 проекта.<br /> <br /> == При создании проекта ==<br /> Пример frontend проекта находится в &lt;code&gt;be5/be5-demo&lt;/code&gt;, он содержит пример настройки Gulp для инкрементальной сборки.<br /> <br /> Пример объявления целей be5.deploy и be5.frontend:<br /> <br /> &lt;code&gt;<br /> &lt;target name=&quot;be5.deploy&quot; depends=&quot;prepare&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;compileapp&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;modules&quot; value=&quot;${MODULES}&quot; /&gt;<br /> &lt;property name=&quot;usedatasource&quot; value=&quot;true&quot; /&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;property name=&quot;appencoding&quot; value=&quot;UTF-8&quot; /&gt;<br /> &lt;property name=&quot;SRCDIR&quot; value=&quot;${appabsolutepath}/src&quot; /&gt;<br /> &lt;property name=&quot;PROJECT_SOURCE&quot; value=&quot;${PROJECT_SOURCE}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;ant antfile=&quot;${COMMONDIR}/makefiles/be_webxml.xml&quot; target=&quot;install_context&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;tomcat&quot;&gt;<br /> &lt;available property=&quot;tomcat.is.installed&quot; file=&quot;${TOMCAT_HOME}/webapps&quot; type=&quot;dir&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;be5.frontend&quot; depends=&quot;tomcat,check_for_tomcat&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;fastfrontend&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;/target&gt;<br /> &lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_BeanExplorer5_%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B0 2015-11-23T12:00:55Z

<p>Asko: /* При создании проекта */</p> <hr /> <div>&lt;big&gt;Для сборки BeanExplorer5 проекта необходимо сначала подготовить BeanExplorer5 для сборки.&lt;/big&gt;<br /> <br /> == Подготовка BeanExplorer5 ==<br /> * Необходим Ant. Для установки под Windows необходимо скачать Ant с официального сайта http://ant.apache.org/.<br /> * Необходим NPM. Для установки под Windows необходимо скачать Node.js с официального сайта https://nodejs.org/en/. Мы используем 4 версию.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;ant prepareworkspace&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5/be5-frontend&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;, затем &lt;code&gt;gulp&lt;/code&gt;.<br /> <br /> == Работа с проектом ==<br /> * При первой сборке вызывается &lt;code&gt;ant be5.deploy&lt;/code&gt; в папке проекта.<br /> * При изменении frontend проекта вызывать &lt;code&gt;ant be5.frontend&lt;/code&gt; в папке проекта.<br /> * Не предусмотрено Ant цели для вызова при изменении backend кода.<br /> * Если вы редактируете &lt;code&gt;be5-frontend&lt;/code&gt;, то необходимо вызвать &lt;code&gt;gulp watch&lt;/code&gt; и ''помимо этого'' после редактирования вызывать &lt;code&gt;ant be5.frontend&lt;/code&gt; из папки BeanExplorer5 проекта.<br /> <br /> == При создании проекта ==<br /> Пример frontend проекта находится в &lt;code&gt;be5/be5-demo&lt;/code&gt;, он содержит пример настройки Gulp для инкрементальной сборки.<br /> <br /> Пример объявления целей be5.deploy и be5.frontend:<br /> <br /> &lt;code&gt;<br /> &lt;target name=&quot;be5.deploy&quot; depends=&quot;prepare&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;compileapp&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;modules&quot; value=&quot;${MODULES}&quot; /&gt;<br /> &lt;property name=&quot;usedatasource&quot; value=&quot;true&quot; /&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;property name=&quot;appencoding&quot; value=&quot;UTF-8&quot; /&gt;<br /> &lt;property name=&quot;SRCDIR&quot; value=&quot;${appabsolutepath}/src&quot; /&gt;<br /> &lt;property name=&quot;PROJECT_SOURCE&quot; value=&quot;${PROJECT_SOURCE}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;ant antfile=&quot;${COMMONDIR}/makefiles/be_webxml.xml&quot; target=&quot;install_context&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;tomcat&quot;&gt;<br /> &lt;available property=&quot;tomcat.is.installed&quot; file=&quot;${TOMCAT_HOME}/webapps&quot; type=&quot;dir&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;be5.frontend&quot; depends=&quot;tomcat,check_for_tomcat&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;fastfrontend&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;/target&gt;<br /> &lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5 2015-11-23T12:00:25Z

<p>Asko: </p> <hr /> <div>&lt;big&gt;Это основная статья о BeanExplorer5.&lt;/big&gt;<br /> <br /> ==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_BeanExplorer5_%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B0 2015-11-23T11:59:42Z

<p>Asko: /* Работа с проектом */</p> <hr /> <div>&lt;big&gt;Для сборки BeanExplorer5 проекта необходимо сначала подготовить BeanExplorer5 для сборки.&lt;/big&gt;<br /> <br /> == Подготовка BeanExplorer5 ==<br /> * Необходим Ant. Для установки под Windows необходимо скачать Ant с официального сайта http://ant.apache.org/.<br /> * Необходим NPM. Для установки под Windows необходимо скачать Node.js с официального сайта https://nodejs.org/en/. Мы используем 4 версию.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;ant prepareworkspace&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5/be5-frontend&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;, затем &lt;code&gt;gulp&lt;/code&gt;.<br /> <br /> == Работа с проектом ==<br /> * При первой сборке вызывается &lt;code&gt;ant be5.deploy&lt;/code&gt; в папке проекта.<br /> * При изменении frontend проекта вызывать &lt;code&gt;ant be5.frontend&lt;/code&gt; в папке проекта.<br /> * Не предусмотрено Ant цели для вызова при изменении backend кода.<br /> * Если вы редактируете &lt;code&gt;be5-frontend&lt;/code&gt;, то необходимо вызвать &lt;code&gt;gulp watch&lt;/code&gt; и ''помимо этого'' после редактирования вызывать &lt;code&gt;ant be5.frontend&lt;/code&gt; из папки BeanExplorer5 проекта.<br /> <br /> == При создании проекта ==<br /> Пример frontend проекта находится в &lt;code&gt;be5/be5-demo&lt;/code&gt;, он содержит пример настройки Gulp для инкрементальной сборки.<br /> <br /> Примеры объявления целей be5.deploy и be5.frontend:<br /> <br /> &lt;code&gt;<br /> &lt;target name=&quot;be5.deploy&quot; depends=&quot;prepare&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;compileapp&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;modules&quot; value=&quot;${MODULES}&quot; /&gt;<br /> &lt;property name=&quot;usedatasource&quot; value=&quot;true&quot; /&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;property name=&quot;appencoding&quot; value=&quot;UTF-8&quot; /&gt;<br /> &lt;property name=&quot;SRCDIR&quot; value=&quot;${appabsolutepath}/src&quot; /&gt;<br /> &lt;property name=&quot;PROJECT_SOURCE&quot; value=&quot;${PROJECT_SOURCE}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;ant antfile=&quot;${COMMONDIR}/makefiles/be_webxml.xml&quot; target=&quot;install_context&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;tomcat&quot;&gt;<br /> &lt;available property=&quot;tomcat.is.installed&quot; file=&quot;${TOMCAT_HOME}/webapps&quot; type=&quot;dir&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;be5.frontend&quot; depends=&quot;tomcat,check_for_tomcat&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;fastfrontend&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;/target&gt;<br /> &lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_BeanExplorer5_%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B0 2015-11-23T11:57:46Z

<p>Asko: /* При создании проекта */</p> <hr /> <div>&lt;big&gt;Для сборки BeanExplorer5 проекта необходимо сначала подготовить BeanExplorer5 для сборки.&lt;/big&gt;<br /> <br /> == Подготовка BeanExplorer5 ==<br /> * Необходим Ant. Для установки под Windows необходимо скачать Ant с официального сайта http://ant.apache.org/.<br /> * Необходим NPM. Для установки под Windows необходимо скачать Node.js с официального сайта https://nodejs.org/en/. Мы используем 4 версию.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;ant prepareworkspace&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5/be5-frontend&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;, затем &lt;code&gt;gulp&lt;/code&gt;.<br /> <br /> == Работа с проектом ==<br /> * При первой сборке вызывается &lt;code&gt;ant be5.deploy&lt;/code&gt; в папке проекта.<br /> * При изменении frontend проекта вызывать &lt;code&gt;ant be5.frontend&lt;/code&gt; в папке проекта.<br /> * Не предусмотрено Ant цели для вызова при изменении backend кода.<br /> <br /> == При создании проекта ==<br /> Пример frontend проекта находится в &lt;code&gt;be5/be5-demo&lt;/code&gt;, он содержит пример настройки Gulp для инкрементальной сборки.<br /> <br /> Примеры объявления целей be5.deploy и be5.frontend:<br /> <br /> &lt;code&gt;<br /> &lt;target name=&quot;be5.deploy&quot; depends=&quot;prepare&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;compileapp&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;modules&quot; value=&quot;${MODULES}&quot; /&gt;<br /> &lt;property name=&quot;usedatasource&quot; value=&quot;true&quot; /&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;property name=&quot;appencoding&quot; value=&quot;UTF-8&quot; /&gt;<br /> &lt;property name=&quot;SRCDIR&quot; value=&quot;${appabsolutepath}/src&quot; /&gt;<br /> &lt;property name=&quot;PROJECT_SOURCE&quot; value=&quot;${PROJECT_SOURCE}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;ant antfile=&quot;${COMMONDIR}/makefiles/be_webxml.xml&quot; target=&quot;install_context&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;tomcat&quot;&gt;<br /> &lt;available property=&quot;tomcat.is.installed&quot; file=&quot;${TOMCAT_HOME}/webapps&quot; type=&quot;dir&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;be5.frontend&quot; depends=&quot;tomcat,check_for_tomcat&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;fastfrontend&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;/target&gt;<br /> &lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_BeanExplorer5_%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B0 2015-11-23T11:56:54Z

<p>Asko: Новая страница: «&lt;big&gt;Для сборки BeanExplorer5 проекта необходимо сначала подготовить BeanExplorer5 для сборки.&lt;/big&gt; == По…»</p> <hr /> <div>&lt;big&gt;Для сборки BeanExplorer5 проекта необходимо сначала подготовить BeanExplorer5 для сборки.&lt;/big&gt;<br /> <br /> == Подготовка BeanExplorer5 ==<br /> * Необходим Ant. Для установки под Windows необходимо скачать Ant с официального сайта http://ant.apache.org/.<br /> * Необходим NPM. Для установки под Windows необходимо скачать Node.js с официального сайта https://nodejs.org/en/. Мы используем 4 версию.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;ant prepareworkspace&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;.<br /> * В папке &lt;code&gt;be5/be5-frontend&lt;/code&gt; вызвать &lt;code&gt;npm install&lt;/code&gt;, затем &lt;code&gt;gulp&lt;/code&gt;.<br /> <br /> == Работа с проектом ==<br /> * При первой сборке вызывается &lt;code&gt;ant be5.deploy&lt;/code&gt; в папке проекта.<br /> * При изменении frontend проекта вызывать &lt;code&gt;ant be5.frontend&lt;/code&gt; в папке проекта.<br /> * Не предусмотрено Ant цели для вызова при изменении backend кода.<br /> <br /> == При создании проекта ==<br /> Пример frontend проекта находится в &lt;code&gt;be5/be5-demo&lt;/code&gt; с примером настройки Gulp для инкрементальной сборки этого проекта.<br /> <br /> Примеры объявления целей be5.deploy и be5.frontend:<br /> <br /> &lt;code&gt;<br /> &lt;target name=&quot;be5.deploy&quot; depends=&quot;prepare&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;compileapp&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;modules&quot; value=&quot;${MODULES}&quot; /&gt;<br /> &lt;property name=&quot;usedatasource&quot; value=&quot;true&quot; /&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;property name=&quot;appencoding&quot; value=&quot;UTF-8&quot; /&gt;<br /> &lt;property name=&quot;SRCDIR&quot; value=&quot;${appabsolutepath}/src&quot; /&gt;<br /> &lt;property name=&quot;PROJECT_SOURCE&quot; value=&quot;${PROJECT_SOURCE}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;ant antfile=&quot;${COMMONDIR}/makefiles/be_webxml.xml&quot; target=&quot;install_context&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;tomcat&quot;&gt;<br /> &lt;available property=&quot;tomcat.is.installed&quot; file=&quot;${TOMCAT_HOME}/webapps&quot; type=&quot;dir&quot;/&gt;<br /> &lt;/target&gt;<br /> <br /> &lt;target name=&quot;be5.frontend&quot; depends=&quot;tomcat,check_for_tomcat&quot;&gt;<br /> &lt;property name=&quot;appabsolutepath&quot; location=&quot;..&quot; /&gt;<br /> &lt;ant dir=&quot;../../be5&quot; target=&quot;fastfrontend&quot; inheritAll=&quot;false&quot;&gt;<br /> &lt;property name=&quot;appname&quot; value=&quot;${PROJECT_NAME}&quot; /&gt;<br /> &lt;property name=&quot;appdir&quot; value=&quot;${appabsolutepath}&quot; /&gt;<br /> &lt;/ant&gt;<br /> &lt;/target&gt;<br /> &lt;/code&gt;<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5 2015-11-23T11:33:05Z

<p>Asko: </p> <hr /> <div>Это основная статья о BeanExplorer5.<br /> <br /> ==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer5 2015-11-23T11:32:35Z

<p>Asko: Новая страница: «==Сборка BeanExplorer5== См. Сборка BeanExplorer5 проекта. Category:BeanExplorer5»</p> <hr /> <div>==Сборка BeanExplorer5==<br /> См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].<br /> <br /> [[Category:BeanExplorer5]]</div>

Asko http://wiki.dote.ru/index.php/%D0%97%D0%B0%D0%B3%D0%BB%D0%B0%D0%B2%D0%BD%D0%B0%D1%8F_%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0 2015-11-23T11:29:09Z

<p>Asko: /* BeanExplorer5 */</p> <hr /> <div>=== BeanExplorer4 ===<br /> * [[BeanExplorer4]]<br /> ** [[Для разработчиков BE4]]<br /> * [[Компиляция и запуск BeanExplorer4]]<br /> * [[Использование ant]]<br /> * [[Поддержка СУБД]]<br /> * [[Типы колонок]]<br /> * [[Структура проекта]]<br /> * [[Usecases|Usecases с картиночками]]<br /> * [[JavaScript Debugger]]<br /> * [[Extras]]<br /> * [[Entity template|Шаблоны для сущностей]]<br /> <br /> === Freemarker ===<br /> * [[Freemarker]]<br /> * [[Встроенные функции]]<br /> * [[Макросы]]<br /> * [[Объекты]]<br /> * [[Пользовательские макросы]]<br /> * [[Создание своих макросов]]<br /> * [[Built-ins]]<br /> <br /> === BeanExplorer5 ===<br /> * [[:Category:BeanExplorer5|Категория BeanExplorer5]]<br /> * [[BeanExplorer5|BeanExplorer5]]<br /> * [[BE-SQL|SQL-диалект BeanExplorer5]]<br /> ----<br /> <br /> === Внешние ссылки ===<br /> * BeanExplorer4 на Edge Wiki [https://sites.google.com/a/developmentontheedge.com/wiki/home/proektnaadokumentacia/beanexplorer4]<br /> ----<br /> Количество статей в вики: '''[[:Special:Statistics|{{NUMBEROFARTICLES}}]]'''.</div>

Asko http://wiki.dote.ru/index.php/%D0%97%D0%B0%D0%B3%D0%BB%D0%B0%D0%B2%D0%BD%D0%B0%D1%8F_%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0 2015-11-23T11:26:56Z

<p>Asko: /* BeanExplorer5 */</p> <hr /> <div>=== BeanExplorer4 ===<br /> * [[BeanExplorer4]]<br /> ** [[Для разработчиков BE4]]<br /> * [[Компиляция и запуск BeanExplorer4]]<br /> * [[Использование ant]]<br /> * [[Поддержка СУБД]]<br /> * [[Типы колонок]]<br /> * [[Структура проекта]]<br /> * [[Usecases|Usecases с картиночками]]<br /> * [[JavaScript Debugger]]<br /> * [[Extras]]<br /> * [[Entity template|Шаблоны для сущностей]]<br /> <br /> === Freemarker ===<br /> * [[Freemarker]]<br /> * [[Встроенные функции]]<br /> * [[Макросы]]<br /> * [[Объекты]]<br /> * [[Пользовательские макросы]]<br /> * [[Создание своих макросов]]<br /> * [[Built-ins]]<br /> <br /> === BeanExplorer5 ===<br /> * [[BE-SQL|SQL-диалект BeanExplorer5]]<br /> * [[:Category:BeanExplorer5|BeanExplorer5]]<br /> ----<br /> <br /> === Внешние ссылки ===<br /> * BeanExplorer4 на Edge Wiki [https://sites.google.com/a/developmentontheedge.com/wiki/home/proektnaadokumentacia/beanexplorer4]<br /> ----<br /> Количество статей в вики: '''[[:Special:Statistics|{{NUMBEROFARTICLES}}]]'''.</div>

Asko http://wiki.dote.ru/index.php/%D0%97%D0%B0%D0%B3%D0%BB%D0%B0%D0%B2%D0%BD%D0%B0%D1%8F_%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0 2015-11-23T11:25:40Z

<p>Asko: /* BeanExplorer5 */</p> <hr /> <div>=== BeanExplorer4 ===<br /> * [[BeanExplorer4]]<br /> ** [[Для разработчиков BE4]]<br /> * [[Компиляция и запуск BeanExplorer4]]<br /> * [[Использование ant]]<br /> * [[Поддержка СУБД]]<br /> * [[Типы колонок]]<br /> * [[Структура проекта]]<br /> * [[Usecases|Usecases с картиночками]]<br /> * [[JavaScript Debugger]]<br /> * [[Extras]]<br /> * [[Entity template|Шаблоны для сущностей]]<br /> <br /> === Freemarker ===<br /> * [[Freemarker]]<br /> * [[Встроенные функции]]<br /> * [[Макросы]]<br /> * [[Объекты]]<br /> * [[Пользовательские макросы]]<br /> * [[Создание своих макросов]]<br /> * [[Built-ins]]<br /> <br /> === BeanExplorer5 ===<br /> * [[BE-SQL|SQL-диалект BeanExplorer5]]<br /> * [[BeanExplorer5|BeanExplorer5]]<br /> ----<br /> <br /> === Внешние ссылки ===<br /> * BeanExplorer4 на Edge Wiki [https://sites.google.com/a/developmentontheedge.com/wiki/home/proektnaadokumentacia/beanexplorer4]<br /> ----<br /> Количество статей в вики: '''[[:Special:Statistics|{{NUMBEROFARTICLES}}]]'''.</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer4 2015-11-13T05:37:42Z

<p>Asko: /* Как настроить Tomcat для возможности подгрузить изменения в class-файлах. */</p> <hr /> <div>== Как начать работу с BeanExplorer 4 ==<br /> Для установки: смотрите «[[Компиляция и запуск BeanExplorer4|компиляция и запуск]]».<br /> <br /> Есть три способа начать работать с проектом BeanExplorer 4.<br /> # Взять готовый проект. В таком случае просто откройте перспективу BeanExplorer, сделайте импорт проекта обычным способом, а затем кликните на проект или project.yaml правой кнопкой мыши (во view Project Explorer) и выберите &quot;BeanExplorer -&gt; Open BeanExplorer Project&quot;. Проект появится во view с названием Model.<br /> # Преобразовать старый BeanExplorer-проект. Для этого выберите File-&gt;New-&gt;Project..., BeanExplorer-&gt;New BeanExplorer Project Using Database Connection (более короткий способ это сделать - это выбрать пункт меню BeanExplorer-&gt;Quick Load Using Database Connection, если уже есть профиль для подключения к базе данных). Если нет ни одного профиля для подключения к СУБД, его надо создать, нажав &quot;Create a new connection profile&quot; и введя всю необходимую информацию для подключения, а также выбрав JDBC драйвер. Пароль обязательно сохранить. Можно это [[BeanExplorer4#Как создать новый профиль подключения к БД|сделать до начала создания проекта, обычными средставми Eclipse DTP]]. После нажатия на кнопку &quot;Finish&quot; загруженный проект должен отобразиться во view &quot;Model&quot;. Преобразование может быть неточным и придётся его доделывать вручную. Кроме того, не сохранятся никакие M4 макросы.<br /> # Создать новый проект.<br /> #* File -&gt; New -&gt; Project...<br /> #* BeanExplorer -&gt; BeanExplorer Project, Next<br /> #* Ввести имя проекта, изначальный список ролей, допустимых в проекте, и набор поддерживаемых языков (роли и языки всегда можно будет добавить ещё).<br /> #* Выбрать набор используемых модулей и фитч. Модули аналогичны самим BeanExplorer4 проектам. Модуль 'beanexplorer' всегда добавляется в проект безусловно, поэтому его нельзя выбрать самому.<br /> #* Заполнить параметры подключения к базе данных. У нас в проектах всегда используются connection profiles и Eclipse DTP, поэтому для начала работы с BeanExplorer4 сначала необходимо создать базу данных и connection profile для её использования. Тестовый пользователь - одновременно и администратор базы данных и пользователь-администратор из создаваемого BeanExplorer4 приложения.<br /> # Создать новый проект возможно и из консоли. Для этого запускается Ant target с именем 'wizard' (зайти в консоли в папку 'be4/src' и напечатать 'ant wizard', если у вас установлен Ant).<br /> <br /> == Описание по каждому редактору и view ==<br /> * Model (view). Дерево проекта.<br /> * Properties (view). Свойства выделенного в дереве проекта элемента.<br /> * Documentation (view). Документация к выделенному в дереве проекта элементу.<br /> * Tasks (view). Отображает все маркеры @todo и @check, найденные в документации ко всем элементам проекта и при необходимости скачивает задачи с ERP или Bugzilla. Для того, чтобы связать открытый проект с ERP, необходимо в его свойствах (Properties view!) заполнить поле 'ERP project identifier'. Аналогично для связи с Bugzilla имеется поле 'Bugzilla product name'. Помимо этих полей потребуеются логин и пароль, которые возможно ввести на странице BeanExplorer в настройках (Window-&gt;Preferences) (если они не введены, при попытке подключиться к ERP или Bugzilla BeanExplorer4 предложит вам ввести их в диалоговом окошке). Для того, чтобы связать какое-нибудь задание из документации с багом в Bugzilla или ERP, в начале его текста нужно указать номер бага с префиксом 'bug' или 'erp' соответственно: например, в тексте документации будет &quot;@todo bug12345 исправить систему подсчёта X&quot;.<br /> * Security (view). Таблица с правами ролей для каждого запроса и каждой операции. Реагирует на то, какой редактор открыт или какой элемент в дереве проектов выбран, и в соответствии с последним выбранным элементов фильтрует таблицу. Если в дереве проектов выбран модуль, то будут отображаться только операции и запросы из этого модуля, если entity, то отображаются только те операции и запросы, что относятся к данной entity. Фильтр по ролям позволяет выбрать все операции и запросы, которые может выполнять выбранная роль.<br /> * Diagram (editor). Редактор диаграмм. Позволяет открывать .dml файлы и редактировать несколько их видов. Диаграммы каждого вида возможно создать пустыми выбором соответствующего пункта в основном меню BeanExplorer (BeanExplorer-&gt;Create *** Diagram/Board). Поддерживаемые виды диаграмм:<br /> ** ER модели. Могут быть открыты посредством клика на модуль и выбора &quot;Create Diagram From This Module&quot;.<br /> ** EPC (Event-Process Chain) диаграммы.<br /> ** CFF (Cross-Functional Flowchart) диаграммы.<br /> ** Planning boards - доски с задачами.<br /> * Diagram Layout (view). Позволяет перераспределить элементы ER диаграмы. Всегда относится к диаграмме из редактора ER, которым пользовались последним.<br /> * SQL Editor (editor). Позволяет редактировать SQL запросы - открывается при клике на запросы в дереве проекта. Почти то же самое, что и SQL редактор из Eclipse DTP. Позволяет запускать SQL запросы (правый щелчок мышью-&gt;Execute All). Отличается от оригинального тем, что, во-первых, не сохраняет изменения в файл (при попытке сохранить изменения окажутся в модели BeanExplorer 4), а, во-вторых, позволяет запускать SQL с учётом макропроцессора FreeMarker и [https://sites.google.com/a/developmentontheedge.com/wiki/home/proektnaadokumentacia/beanexplorer/beanexplorerdocrus плейсхолдеров BeanExplorer] (правый щелчок мышью-&gt;Run или &quot;Run BeanExplorer SQL Query&quot; на toolbar'е).<br /> * Query Executor (view).<br /> ** Позволяет определить контекст выполнения SQL запроса - посредством выбора своих параметров запроса или сессии (при этом запрос пока выполняется только под администратором).<br /> ** Позволяет посмотреть результаты запуска SQL запроса. Автоматически активируется при SQL запросе. Позволяет посмотреть результаты запроса как в виде простой таблицы, так и в виде HTML после обработки в BeanExplorer, а также посмотреть обработанные представления запроса — после макропроцессора FreeMarker и в чистом SQL виде.<br /> * JavaScript Editor (editor). Позволяет редактировать JavaScript скрипты - открывается при клике на JavaScript/server операции в дереве проекта. Почти то же самое, что и обычный JavaScript редактор из Eclipse JSDT. Отличается тем, что позволяет запускать Rhino JavaScript (&quot;Run JavaScript&quot; на toolbar'е или &quot;Execute&quot; в Operation Parameters view). Результат вызова операции открывается в браузере.<br /> * Operation Parameters (view). Позволяет определить контекст выполнения JavaScript/server операции посредством задания параметров и выбранных строчек. Также позволяет выбрать метод для запуска: getParameters(), invoke() или getRedirectURL() (последний пока не поддерживается).<br /> * Localization (view). [[Localizations|Локализация]], относящаяся к выделенному в дереве проектов элементу. Отображается при выборе entity, operation или query.<br /> <br /> == Основная информация для понимания BeanExplorer 4 ==<br /> # Основное представление проекта BeanExplorer 4 - это не база данных, не YAML проект, а дерево проекта в Model view. При открытии BeanExplorer 4 проекта, он оказывается в Model view. И только при сохранении он сериализуется в YAML<br /> # Основные простейшие действия с проектом - создание/удаление сущностей (entities), операций (operation) и запросов (query) - делаются из контекстного меню (pop-up) в Model view.<br /> # Если с каким-нибудь узлом дерева проекта может быть связан редактор, то при выделении этого узла открывается редактор. Например, для JavaScript/server операции открывается JavaScript редактор, для 1D запроса - SQL редактор, для custom step - текстовый редактор, для Java операции открывается Java редактор (если .java файл с соответствующим именем находится в рабочем пространстве Eclipse). Некоторые редакторы при сохранении никак не меняют файлы - файлы будут изменены только при сохранении проекта.<br /> # У большинство элементов из дерева проекта есть свойства, которые возможно редактировать в Properties view.<br /> # Для любого подключения к базе данных необходим connection profile ([http://help.eclipse.org/helios/index.jsp?topic=%2Forg.eclipse.datatools.connectivity.doc.user%2Fdoc%2Fhtml%2Fasc1229700343352.html в документации по Kepler]). При импорте готового проекта connection profile создаётся автоматически, однако вручную всё же необходимо выбрать к нему JDBC Connector (если СУБД для подключения используется впервые). Connection Profile необходим как для SQL запросов из обычного SQL редактора Eclipse DTP, так и для запросов BeanExplorer. Настройки connection profiles находятся в разделе проекта &quot;Connection profiles&quot;, в &quot;папочках&quot; Local и Remote. Эти настройки сохраняются в XML при сохранении BeanExplorer 4 проекта, а при его открытии воссоздаются, и если Eclipse DTP не имеет connection profiles с соответствующими именами, то они будут созданы. Конкретнее - эти настройки хранятся в двух файлах: connectionProfiles.local.xml и connectionProfiles.remote.xml, причём предполагается, что .local вписан в .gitignore, а .remote - нет. Для возможности подключиться к базе данных всегда должен быть выбран в качестве текущего какой-нибудь connection profile. Выбирается он в свойствах проекта (Properties view, &quot;Connection profile name&quot;) - в соответствующем combo box отображаются только те профили, которые есть в Local или Remote. Добавить новый connection profile в проект BeanExplorer 4 возможно через контекстное меню (для этого его сначала необходимо создать в Data Source Explorer view (из Eclipse DTP)).<br /> <br /> == Работа с BeanExplorer 4 для аналитиков ==<br /> Для некоторых типов элементов из дерева проектов возможно приписывать комментарии/документацию. На данный момент это следующие типы элементов:<br /> * проект,<br /> * модули (в т.ч. application),<br /> * сущности (entities - всё, что находится внутри модуля в папках Collections, Dictionaries, Tables, Generic Collections, Metadata),<br /> * операции,<br /> * запросы.<br /> Документация отображается в Documentation view. Если в документации элемента есть маркер @todo или @check, то строка с этим маркером окажется и в другом view: Tasks. При клике на какую-либо строчку из Tasks будет выделен соответствующий ей элемент в Model view.<br /> <br /> [[Файл:Analyst1.png]]<br /> <br /> === Возможности назначения ролей ===<br /> * Все роли перечислены в свойствах проекта. При клике на список ролей (&quot;Project roles&quot; в Properties view при выбранно проекте) появляется панель, позволяющая добавлять роли.<br /> * Для операций и запросов роли назначаются во view Security.<br /> <br /> [[Файл:Analyst2.png]]<br /> <br /> == Usecases ==<br /> Перенесены [[Usecases|сюда]].<br /> <br /> == Компиляция и запуск Eclipse с плагином BeanExplorer4 ==<br /> Здесь: [[Компиляция и запуск BeanExplorer4]] (инструкции для тех, кто запускает Eclipse BeanExplorer4 из под другого экземпляра Eclipse).<br /> <br /> == Структура проекта BeanExplorer 4 ==<br /> [[Структура проекта|Структура]] проекта BeanExplorer 4<br /> <br /> == Процесс разработки ==<br /> === Использование Ant ===<br /> [[Использование ant|Использование Ant]]<br /> <br /> === Использование шаблонов Freemarker ===<br /> Использование шаблонов [[Freemarker|Freemarker]]<br /> <br /> === JavaScript Debugger ===<br /> Текущее состояние [[JavaScript Debugger|JavaScript Debugger]]<br /> <br /> === Поддержка СУБД ===<br /> Поддержка [[Поддержка СУБД|различных СУБД]]<br /> <br /> == Полезная информация, которая может помочь при работе с BeanExplorer 4 ==<br /> === Как устанавливать плагины/фитчи из архива ===<br /> # Заходим в... Help-&gt;Install New Software. Add...-&gt;Archive... выбрать архив, OK.<br /> # Снять галочку &quot;Group items by category&quot;, если не видно пунктов для установки. Это может занять продолжительное время, т.к. с основного репозитория Eclipse будут скачиваться недостающие плагины.<br /> <br /> === Где взять редактор YAML ===<br /> Update site: &lt;code&gt;http://dadacoalition.org/yedit&lt;/code&gt;<br /> <br /> (Site: [https://code.google.com/p/yedit/ https://code.google.com/p/yedit/])<br /> <br /> === Где взять редактор FreeMarker ===<br /> Update site: &lt;code&gt;http://download.jboss.org/jbosstools/updates/stable/kepler/&lt;/code&gt;<br /> <br /> Или:<br /> <br /> Help-&gt;Eclipse Marketplace... ищем &quot;JBoss Tools&quot;, жмём Install у JBoss Tools (Kepler), снимаем галочку со всего и выбираем JBoss Tools (Kepler)-&gt;FreeMarker IDE.<br /> <br /> === Как настроить Tomcat для возможности подгрузить изменения в class-файлах. ===<br /> 1. Add the following lines into /conf/tomcat-users.xml (inside the root element &lt;tomcat-users&gt;):<br /> &lt;role rolename=&quot;manager-script&quot;/&gt;<br /> &lt;user username=&quot;tomcat&quot; password=&quot;tomcat&quot; roles=&quot;manager-script&quot;/&gt;<br /> <br /> 2. Create /conf/Catalina/localhost/manager.xml with the following content:<br /> &lt;Context privileged=&quot;true&quot; antiResourceLocking=&quot;false&quot;<br /> docBase=&quot;${catalina.home}/webapps/manager&quot;&gt;<br /> &lt;Valve className=&quot;org.apache.catalina.valves.RemoteAddrValve&quot;<br /> allow=&quot;127\.0\.0\.1&quot; /&gt;<br /> &lt;/Context&gt;<br /> <br /> Подробнее [http://tomcat.apache.org/tomcat-7.0-doc/manager-howto.html здесь] и [http://www.mulesoft.com/tcat/tomcat-reload здесь].<br /> <br /> 3. You can change the username or the password, but you should ensure that your connection profile uses these username and password. Beside this you can change the URL that will be called to refresh Tomcat. Note that this action uses the Tomcat application name from the connection profile. Tomcat path should be set too.<br /> <br /> === Как создать новый профиль подключения к БД ===<br /> * Переключиться в перспективу Database Development. (В Eclipse почти в правом верхнем углу нажать квадратную кнопку с плюсиком &quot;Open Perspective&quot; и выбрать там &quot;Database Development&quot;).<br /> * Во view Data Source Explorer кликнуть правой кнопкой мыши на Database Connections, New....<br /> * Выбрать в диалоговом окне тип используемой БД (напр., PostgreSQL), ввести нормальное имя для подключения (например, &quot;condo&quot;), Next.<br /> * Ввести параметры подключения, их можно узнать у администратора БД. При первом создании профиля подключения с данным типом СУБД необходимо выбрать драйвер СУБД (для этого нажать круглишок с плюсиком у combo &quot;Driver&quot;, а в появившемся диалоге на второй вкладке обычно необходимо удалить выбранный драйвер и выбрать свой - мы для удобство поместили все драйвера в папку lib из be4).<br /> * Next, Finish.<br /> * Новый профиль появится в списке Database Connections во view Data Source Explorer.<br /> <br /> = Для разработчиков =<br /> [[Для разработчиков BE4|Сюда]]</div>

Asko http://wiki.dote.ru/index.php/BeanExplorer4 2015-11-13T05:36:45Z

<p>Asko: /* Как настроить Tomcat для возможности подгрузить изменения в class-файлах. */</p> <hr /> <div>== Как начать работу с BeanExplorer 4 ==<br /> Для установки: смотрите «[[Компиляция и запуск BeanExplorer4|компиляция и запуск]]».<br /> <br /> Есть три способа начать работать с проектом BeanExplorer 4.<br /> # Взять готовый проект. В таком случае просто откройте перспективу BeanExplorer, сделайте импорт проекта обычным способом, а затем кликните на проект или project.yaml правой кнопкой мыши (во view Project Explorer) и выберите &quot;BeanExplorer -&gt; Open BeanExplorer Project&quot;. Проект появится во view с названием Model.<br /> # Преобразовать старый BeanExplorer-проект. Для этого выберите File-&gt;New-&gt;Project..., BeanExplorer-&gt;New BeanExplorer Project Using Database Connection (более короткий способ это сделать - это выбрать пункт меню BeanExplorer-&gt;Quick Load Using Database Connection, если уже есть профиль для подключения к базе данных). Если нет ни одного профиля для подключения к СУБД, его надо создать, нажав &quot;Create a new connection profile&quot; и введя всю необходимую информацию для подключения, а также выбрав JDBC драйвер. Пароль обязательно сохранить. Можно это [[BeanExplorer4#Как создать новый профиль подключения к БД|сделать до начала создания проекта, обычными средставми Eclipse DTP]]. После нажатия на кнопку &quot;Finish&quot; загруженный проект должен отобразиться во view &quot;Model&quot;. Преобразование может быть неточным и придётся его доделывать вручную. Кроме того, не сохранятся никакие M4 макросы.<br /> # Создать новый проект.<br /> #* File -&gt; New -&gt; Project...<br /> #* BeanExplorer -&gt; BeanExplorer Project, Next<br /> #* Ввести имя проекта, изначальный список ролей, допустимых в проекте, и набор поддерживаемых языков (роли и языки всегда можно будет добавить ещё).<br /> #* Выбрать набор используемых модулей и фитч. Модули аналогичны самим BeanExplorer4 проектам. Модуль 'beanexplorer' всегда добавляется в проект безусловно, поэтому его нельзя выбрать самому.<br /> #* Заполнить параметры подключения к базе данных. У нас в проектах всегда используются connection profiles и Eclipse DTP, поэтому для начала работы с BeanExplorer4 сначала необходимо создать базу данных и connection profile для её использования. Тестовый пользователь - одновременно и администратор базы данных и пользователь-администратор из создаваемого BeanExplorer4 приложения.<br /> # Создать новый проект возможно и из консоли. Для этого запускается Ant target с именем 'wizard' (зайти в консоли в папку 'be4/src' и напечатать 'ant wizard', если у вас установлен Ant).<br /> <br /> == Описание по каждому редактору и view ==<br /> * Model (view). Дерево проекта.<br /> * Properties (view). Свойства выделенного в дереве проекта элемента.<br /> * Documentation (view). Документация к выделенному в дереве проекта элементу.<br /> * Tasks (view). Отображает все маркеры @todo и @check, найденные в документации ко всем элементам проекта и при необходимости скачивает задачи с ERP или Bugzilla. Для того, чтобы связать открытый проект с ERP, необходимо в его свойствах (Properties view!) заполнить поле 'ERP project identifier'. Аналогично для связи с Bugzilla имеется поле 'Bugzilla product name'. Помимо этих полей потребуеются логин и пароль, которые возможно ввести на странице BeanExplorer в настройках (Window-&gt;Preferences) (если они не введены, при попытке подключиться к ERP или Bugzilla BeanExplorer4 предложит вам ввести их в диалоговом окошке). Для того, чтобы связать какое-нибудь задание из документации с багом в Bugzilla или ERP, в начале его текста нужно указать номер бага с префиксом 'bug' или 'erp' соответственно: например, в тексте документации будет &quot;@todo bug12345 исправить систему подсчёта X&quot;.<br /> * Security (view). Таблица с правами ролей для каждого запроса и каждой операции. Реагирует на то, какой редактор открыт или какой элемент в дереве проектов выбран, и в соответствии с последним выбранным элементов фильтрует таблицу. Если в дереве проектов выбран модуль, то будут отображаться только операции и запросы из этого модуля, если entity, то отображаются только те операции и запросы, что относятся к данной entity. Фильтр по ролям позволяет выбрать все операции и запросы, которые может выполнять выбранная роль.<br /> * Diagram (editor). Редактор диаграмм. Позволяет открывать .dml файлы и редактировать несколько их видов. Диаграммы каждого вида возможно создать пустыми выбором соответствующего пункта в основном меню BeanExplorer (BeanExplorer-&gt;Create *** Diagram/Board). Поддерживаемые виды диаграмм:<br /> ** ER модели. Могут быть открыты посредством клика на модуль и выбора &quot;Create Diagram From This Module&quot;.<br /> ** EPC (Event-Process Chain) диаграммы.<br /> ** CFF (Cross-Functional Flowchart) диаграммы.<br /> ** Planning boards - доски с задачами.<br /> * Diagram Layout (view). Позволяет перераспределить элементы ER диаграмы. Всегда относится к диаграмме из редактора ER, которым пользовались последним.<br /> * SQL Editor (editor). Позволяет редактировать SQL запросы - открывается при клике на запросы в дереве проекта. Почти то же самое, что и SQL редактор из Eclipse DTP. Позволяет запускать SQL запросы (правый щелчок мышью-&gt;Execute All). Отличается от оригинального тем, что, во-первых, не сохраняет изменения в файл (при попытке сохранить изменения окажутся в модели BeanExplorer 4), а, во-вторых, позволяет запускать SQL с учётом макропроцессора FreeMarker и [https://sites.google.com/a/developmentontheedge.com/wiki/home/proektnaadokumentacia/beanexplorer/beanexplorerdocrus плейсхолдеров BeanExplorer] (правый щелчок мышью-&gt;Run или &quot;Run BeanExplorer SQL Query&quot; на toolbar'е).<br /> * Query Executor (view).<br /> ** Позволяет определить контекст выполнения SQL запроса - посредством выбора своих параметров запроса или сессии (при этом запрос пока выполняется только под администратором).<br /> ** Позволяет посмотреть результаты запуска SQL запроса. Автоматически активируется при SQL запросе. Позволяет посмотреть результаты запроса как в виде простой таблицы, так и в виде HTML после обработки в BeanExplorer, а также посмотреть обработанные представления запроса — после макропроцессора FreeMarker и в чистом SQL виде.<br /> * JavaScript Editor (editor). Позволяет редактировать JavaScript скрипты - открывается при клике на JavaScript/server операции в дереве проекта. Почти то же самое, что и обычный JavaScript редактор из Eclipse JSDT. Отличается тем, что позволяет запускать Rhino JavaScript (&quot;Run JavaScript&quot; на toolbar'е или &quot;Execute&quot; в Operation Parameters view). Результат вызова операции открывается в браузере.<br /> * Operation Parameters (view). Позволяет определить контекст выполнения JavaScript/server операции посредством задания параметров и выбранных строчек. Также позволяет выбрать метод для запуска: getParameters(), invoke() или getRedirectURL() (последний пока не поддерживается).<br /> * Localization (view). [[Localizations|Локализация]], относящаяся к выделенному в дереве проектов элементу. Отображается при выборе entity, operation или query.<br /> <br /> == Основная информация для понимания BeanExplorer 4 ==<br /> # Основное представление проекта BeanExplorer 4 - это не база данных, не YAML проект, а дерево проекта в Model view. При открытии BeanExplorer 4 проекта, он оказывается в Model view. И только при сохранении он сериализуется в YAML<br /> # Основные простейшие действия с проектом - создание/удаление сущностей (entities), операций (operation) и запросов (query) - делаются из контекстного меню (pop-up) в Model view.<br /> # Если с каким-нибудь узлом дерева проекта может быть связан редактор, то при выделении этого узла открывается редактор. Например, для JavaScript/server операции открывается JavaScript редактор, для 1D запроса - SQL редактор, для custom step - текстовый редактор, для Java операции открывается Java редактор (если .java файл с соответствующим именем находится в рабочем пространстве Eclipse). Некоторые редакторы при сохранении никак не меняют файлы - файлы будут изменены только при сохранении проекта.<br /> # У большинство элементов из дерева проекта есть свойства, которые возможно редактировать в Properties view.<br /> # Для любого подключения к базе данных необходим connection profile ([http://help.eclipse.org/helios/index.jsp?topic=%2Forg.eclipse.datatools.connectivity.doc.user%2Fdoc%2Fhtml%2Fasc1229700343352.html в документации по Kepler]). При импорте готового проекта connection profile создаётся автоматически, однако вручную всё же необходимо выбрать к нему JDBC Connector (если СУБД для подключения используется впервые). Connection Profile необходим как для SQL запросов из обычного SQL редактора Eclipse DTP, так и для запросов BeanExplorer. Настройки connection profiles находятся в разделе проекта &quot;Connection profiles&quot;, в &quot;папочках&quot; Local и Remote. Эти настройки сохраняются в XML при сохранении BeanExplorer 4 проекта, а при его открытии воссоздаются, и если Eclipse DTP не имеет connection profiles с соответствующими именами, то они будут созданы. Конкретнее - эти настройки хранятся в двух файлах: connectionProfiles.local.xml и connectionProfiles.remote.xml, причём предполагается, что .local вписан в .gitignore, а .remote - нет. Для возможности подключиться к базе данных всегда должен быть выбран в качестве текущего какой-нибудь connection profile. Выбирается он в свойствах проекта (Properties view, &quot;Connection profile name&quot;) - в соответствующем combo box отображаются только те профили, которые есть в Local или Remote. Добавить новый connection profile в проект BeanExplorer 4 возможно через контекстное меню (для этого его сначала необходимо создать в Data Source Explorer view (из Eclipse DTP)).<br /> <br /> == Работа с BeanExplorer 4 для аналитиков ==<br /> Для некоторых типов элементов из дерева проектов возможно приписывать комментарии/документацию. На данный момент это следующие типы элементов:<br /> * проект,<br /> * модули (в т.ч. application),<br /> * сущности (entities - всё, что находится внутри модуля в папках Collections, Dictionaries, Tables, Generic Collections, Metadata),<br /> * операции,<br /> * запросы.<br /> Документация отображается в Documentation view. Если в документации элемента есть маркер @todo или @check, то строка с этим маркером окажется и в другом view: Tasks. При клике на какую-либо строчку из Tasks будет выделен соответствующий ей элемент в Model view.<br /> <br /> [[Файл:Analyst1.png]]<br /> <br /> === Возможности назначения ролей ===<br /> * Все роли перечислены в свойствах проекта. При клике на список ролей (&quot;Project roles&quot; в Properties view при выбранно проекте) появляется панель, позволяющая добавлять роли.<br /> * Для операций и запросов роли назначаются во view Security.<br /> <br /> [[Файл:Analyst2.png]]<br /> <br /> == Usecases ==<br /> Перенесены [[Usecases|сюда]].<br /> <br /> == Компиляция и запуск Eclipse с плагином BeanExplorer4 ==<br /> Здесь: [[Компиляция и запуск BeanExplorer4]] (инструкции для тех, кто запускает Eclipse BeanExplorer4 из под другого экземпляра Eclipse).<br /> <br /> == Структура проекта BeanExplorer 4 ==<br /> [[Структура проекта|Структура]] проекта BeanExplorer 4<br /> <br /> == Процесс разработки ==<br /> === Использование Ant ===<br /> [[Использование ant|Использование Ant]]<br /> <br /> === Использование шаблонов Freemarker ===<br /> Использование шаблонов [[Freemarker|Freemarker]]<br /> <br /> === JavaScript Debugger ===<br /> Текущее состояние [[JavaScript Debugger|JavaScript Debugger]]<br /> <br /> === Поддержка СУБД ===<br /> Поддержка [[Поддержка СУБД|различных СУБД]]<br /> <br /> == Полезная информация, которая может помочь при работе с BeanExplorer 4 ==<br /> === Как устанавливать плагины/фитчи из архива ===<br /> # Заходим в... Help-&gt;Install New Software. Add...-&gt;Archive... выбрать архив, OK.<br /> # Снять галочку &quot;Group items by category&quot;, если не видно пунктов для установки. Это может занять продолжительное время, т.к. с основного репозитория Eclipse будут скачиваться недостающие плагины.<br /> <br /> === Где взять редактор YAML ===<br /> Update site: &lt;code&gt;http://dadacoalition.org/yedit&lt;/code&gt;<br /> <br /> (Site: [https://code.google.com/p/yedit/ https://code.google.com/p/yedit/])<br /> <br /> === Где взять редактор FreeMarker ===<br /> Update site: &lt;code&gt;http://download.jboss.org/jbosstools/updates/stable/kepler/&lt;/code&gt;<br /> <br /> Или:<br /> <br /> Help-&gt;Eclipse Marketplace... ищем &quot;JBoss Tools&quot;, жмём Install у JBoss Tools (Kepler), снимаем галочку со всего и выбираем JBoss Tools (Kepler)-&gt;FreeMarker IDE.<br /> <br /> === Как настроить Tomcat для возможности подгрузить изменения в class-файлах. ===<br /> 1. Add the following lines into /conf/tomcat-users.xml (inside the root element &lt;tomcat-users&gt;):<br /> &lt;role rolename=&quot;manager-script&quot;/&gt;<br /> &lt;user username=&quot;tomcat&quot; password=&quot;tomcat&quot; roles=&quot;manager-script&quot;/&gt;<br /> <br /> 2. Create /conf/Catalina/localhost/manager.xml with the following content:<br /> &lt;Context privileged=&quot;true&quot; antiResourceLocking=&quot;false&quot;<br /> docBase=&quot;${catalina.home}/webapps/manager&quot;&gt;<br /> &lt;Valve className=&quot;org.apache.catalina.valves.RemoteAddrValve&quot;<br /> allow=&quot;127\.0\.0\.1&quot; /&gt;<br /> &lt;/Context&gt;<br /> <br /> Подробнее [http://tomcat.apache.org/tomcat-7.0-doc/manager-howto.html здесь] и [http://www.mulesoft.com/tcat/tomcat-reload здесь].<br /> <br /> 3. You can change the username or the password, but you should ensure that your connection profile uses these username and password. Beside this you can change the URL that will be called to refresh Tomcat. Note that this action uses the Tomcat application name from the connection profile.<br /> <br /> === Как создать новый профиль подключения к БД ===<br /> * Переключиться в перспективу Database Development. (В Eclipse почти в правом верхнем углу нажать квадратную кнопку с плюсиком &quot;Open Perspective&quot; и выбрать там &quot;Database Development&quot;).<br /> * Во view Data Source Explorer кликнуть правой кнопкой мыши на Database Connections, New....<br /> * Выбрать в диалоговом окне тип используемой БД (напр., PostgreSQL), ввести нормальное имя для подключения (например, &quot;condo&quot;), Next.<br /> * Ввести параметры подключения, их можно узнать у администратора БД. При первом создании профиля подключения с данным типом СУБД необходимо выбрать драйвер СУБД (для этого нажать круглишок с плюсиком у combo &quot;Driver&quot;, а в появившемся диалоге на второй вкладке обычно необходимо удалить выбранный драйвер и выбрать свой - мы для удобство поместили все драйвера в папку lib из be4).<br /> * Next, Finish.<br /> * Новый профиль появится в списке Database Connections во view Data Source Explorer.<br /> <br /> = Для разработчиков =<br /> [[Для разработчиков BE4|Сюда]]</div>

Asko http://wiki.dote.ru/index.php/%D0%9A%D0%BE%D0%BC%D0%BF%D0%B8%D0%BB%D1%8F%D1%86%D0%B8%D1%8F_%D0%B8_%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA_BeanExplorer4 2015-11-02T09:06:02Z

<p>Asko: /* Запуск из-под Eclipse */</p> <hr /> <div>=== Простой запуск ===<br /> Самый простой запуск:<br /> # убедиться, что установлена Java 8 (JRE достаточно);<br /> # установить из Eclipse MarketPlace плагин IvyDE.<br /> # поместить исходники be4 в любую папку;<br /> # сделать одно из следующих действий:<br /> #* скачать готовый Eclipse для Windows x64 с files.dote.ru (обычно это архив eclipse.zip в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation) и разархивировать в любую папку;<br /> #* скачать Eclipse для своей ОС и установить на него содержимое архива repository.zip (обычно он находится в папке Product-&lt;ДАТА-ПУБЛИКАЦИИ&gt; внутри \\files.dote.ru\pub2\_be4\Installation).<br /> <br /> При запуске eclipse.exe спросит, откуда взять исходники be4, если не догадается об их местоположении.<br /> <br /> === Запуск из-под Eclipse ===<br /> Для компиляции необходимы<br /> # '''Java 8''' [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html отсюда],<br /> # '''Eclipse IDE for Java EE Developers''', Eclipse '''Luna SR2''' [http://www.eclipse.org/downloads/packages/release/luna/sr2 отсюда],<br /> # '''Наша версия Freemarker IDE'''.<br /> <br /> ----<br /> <br /> === Варианты установки Freemarker IDE ===<br /> ==== Вариант 1 (запуск без исходного кода Freemarker IDE). ====<br /> Установить содержимое \\files.dote.ru\pub2\_be4\Installation\freemarker.feature.zip<br /> # Заходим в... Help-&gt;Install New Software. Add...-&gt;Archive... выбрать архив, OK.<br /> # Снять галочку &quot;Group items by category&quot;, если не видно пунктов для установки.<br /> <br /> ==== Вариант 2 (для разработчиков Freemarker IDE). ====<br /> # Необходим репозиторий https://github.com/amaembo/jbosstools-freemarker.git<br /> # После скачивания репозитория нужно импортировать два проекта:<br /> #*- org.freemarker.core<br /> #*- org.jboss.ide.eclipse.freemarker. Остальные проекты можно не импортировать или просто закрыть.<br /> # Windows -&gt; Preferences; Plug-In Development -&gt; API Baselines; ввести произвольное имя, Reset, Finish, Apply, OK.<br /> <br /> === Настройки запуска: ===<br /> # Run-&gt;Debug Configurations..., выбрать Eclipse Application, нажать New launch configuration.<br /> # Выбрать каталог в Workspace data (лучше создать новый пустой, например, c:\projects\be4-workspace).<br /> # Execution environment -&gt; Java 1.8.<br /> # Вкладка Arguments Скопировать это значение в поле VM Arguments: '''-Dosgi.requiredJavaVersion=1.8 -Xms256m -Xmx768m -ea'''<br /> # Apply, Debug.</div>

Asko http://wiki.dote.ru/index.php/%D0%94%D0%BB%D1%8F_%D1%80%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%87%D0%B8%D0%BA%D0%BE%D0%B2_BE4 2014-12-05T10:18:06Z

<p>Asko: /* Автосериализация */</p> <hr /> <div>Здесь будет информация по архитектуре BE4.<br /> <br /> На высоком уровне BE4 состоит из нескольких частей:<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро;<br /> * com.beanexplorer.enterprise.metadata.ant - реализация Ant задач, объявленных в be4/src/be4lib.xml, эти классы не должны использоваться во время исполнения BEclipse;<br /> * com.beanexplorer.enterprise.be4core - класс Be4QueryExecutor, необходимый для запуска Query относительно простым образом без необходимости хранить Query в таблице (в BE3 запуск Query происходит по имени или идентификатору Query в таблице queries, а мы в BE4 работаем только с модельными объектами представленными в виде Java объектов, а не строк в SQL таблицах); используется для запуска Query в BEeclipse и BE5;<br /> * com.beanexplorer.enterprise.eclipse - UI BEclipse и необходимые для его модельные элементы и view model;<br /> * com.beanexplorer.enterprise.api - заготовка фасада для использования простейшего API в тестах: загрузка проекта из папки (projectApi = Facade.load(path)), получение корректного DatabaseConnector (projectApi.getDatabaseConnector()) и запуск Freemarker скриптов (projectApi.runFreemarkerScript(string));<br /> * com.beanexplorer.enterprise.diagrams - здесь и модельные элементы, и UI для диаграмм; новые виды диаграм легче всего добавлять по аналогии со старыми, смотря на уже готовые классы;<br /> * com.beanexplorer.enterprise.planning - здесь [http://ru.wikipedia.org/wiki/Model-View-ViewModel и Model, и ViewModel, и View] для для [[BeanExplorer4#Описание по каждому редактору и view|TasksView]].<br /> <br /> == Ядро ==<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро.<br /> ** exception - все базовые исключения для BE4, мы используем [http://en.wikipedia.org/wiki/Exception_handling#Checked_exceptions checked exceptions].<br /> ** '''model*''' - самое сердце BE4 - модельные объекты, которые представляют собой [[Структура проекта|дерево проекта]], начиная с класса [[Project]].<br /> ** sql - скачивание legacy метаданных (дерева проекта) из BE3 базы данных, синхронизация с базой данных. <br /> ** serialization - сохранённый на жёстком диске BE4 проект представляется как набор YAML файлов; данном пакете реализованы сериализация и десериализация YAML. <br /> ** freemarker - расширение Freemarker, в частности [[Built-ins|Be4BuiltIns]] и [[Встроенные функции|DatabaseFunctions]], [[макросы]] находятся в be4/src/com/beanexplorer/enterprise/metadata/freemarker/macro/common.ftl.<br /> *** FreemarkerSqlHandler - получает на вход FreemarkerScript и запускает его как SQL, переадресуя сгенерированный текст в SqlExecutor.<br /> ** util - базовые полезности; должны находиться в этом пакете, даже если используются только в UI<br /> <br /> == UI ==<br /> Поскольку BEclipse - это плагин для Eclipse, UI реализован классическим способом для Eclipse плагинов. А именно:<br /> * весь основной функционал описан в plugin.xml,<br /> ** это могут быть меню, команды, view, редакторы, wizard, страницы настроек и прочее. Для просмотра всего фунционала открываем plugin.xml на странице &quot;Extensions&quot;.<br /> <br /> === Команды ===<br /> Для создания команды неоходимо зарегистрировать два расширения:<br /> * org.eclipse.ui.commands<br /> * org.eclipse.ui.handlers<br /> Дело в том, что в Eclipse одна и та же команда может быть запущена разными обработчиками, так что команда разделена на две части - собственно command, представляет собой абстрактную команду с именем и описанием, и handler - обработчик, ссылается на класс, реализующий функционал этой команды и указывающий, может ли он в данный момент обработать действие. Например, в Eclipse есть стандартная команда &quot;Debug&quot;. В разных контекстах её обрабатывает разный обработчик - Java код запускается одним способом, а C++ код другим. При этом кнопка на панели инструментов и биндинг постоянно F11 ссылаются на одно и то же действие.<br /> <br /> Наши обработчики команд лежат в com.beanexplorer.enterprise.eclipse.handlers и имеют названия, представляющие собой глаголы.<br /> <br /> Так что для создания новой команды<br /> * кликаем на org.eclipse.ui.commands в нашем редакторе plugin.xml на вкладке Extensions, New -&gt; command, даём уникальный идентификатор, читаемое имя и категорию (categoryId) com.beanexplorer.be4.ui.commands,<br /> * кликаем на org.eclipse.ui.handlers , New -&gt; handler, выбираем только что созданную команду и новый класс из com.beanexplorer.enterprise.eclipse.handlers.<br /> <br /> === Меню ===<br /> Это расширение org.eclipse.ui.menus (New -&gt; menuContribution). Общий вид ссылки на меню (locationURI):<br /> * [menu|popup|toolbar]:&lt;menuOrPartName&gt;[?after=additions]<br /> Здесь &quot;menu&quot;, &quot;popup&quot;, &quot;toolbar&quot; - предопределённые строки. &lt;menuOrPartName&gt; - либо &quot;известное&quot; имя типа org.eclipse.ui.main.menu или org.eclipse.ui.main.toolbar, либо имя редактора или view типа com.beanexplorer.enterprise.eclipse.BeProjectView.<br /> <br /> popup:com.beanexplorer.enterprise.eclipse.BeProjectView - это, в частности, контекстное меню нашего дерева проекта. Для добавления в него новой команды кликаем на надпись &quot;popup:com.beanexplorer.enterprise.eclipse.BeProjectView&quot; (слева в дереве), New -&gt; command, выбираем команды, указываем текст и выбираем иконку. Готово!<br /> <br /> ==== Замечание ====<br /> Для того, чтобы найти класс с реализацией пункта меню, можно найти соответствующий пункт меню в редакторе plugin.xml, в нём будет указана команда, копируем имя команды в строку поиска в редакторе и находим нужный handler.<br /> <br /> === Редакторы и view ===<br /> Хранятся в<br /> * com.beanexplorer.enterprise.eclipse.editors и<br /> * com.beanexplorer.enterprise.eclipse.views соответственно.<br /> Аналогично командам, создаются через редактор, кликаем на com.beanexplorer.enterprise.eclipse.editors, New -&gt; editor, заполняем необходимые поля. Аналогично со view. Замечу, что клик на метку &quot;class&quot; позволяет создать нужный класс (в случае со view это org.eclipse.ui.part.ViewPart, например).<br /> <br /> === Готовые диалоговые окна ===<br /> com.beanexplorer.enterprise.eclipse.dialogs.Dialogs - простые реализации диалоговых окошек, которых не хватает в org.eclipse.jface.dialogs.MessageDialog.<br /> <br /> === MVVM и упрощение написания UI ===<br /> Многие команды представляют собой одностраничные wizard'ы. Вместо того, чтобы писать с нуля, берём класс com.beanexplorer.enterprise.eclipse.handlers.templates.WizardCommandTemplateWizard, копируем в handlers, переименовываем (Alt+Shift+R) и заполняем всё что нужно.<br /> <br /> Хорошей практикой являет написание UI с использованием шаблона проектирования MVVM. Пример - CreateDaemonWizard.CreateDaemonWizardPage из CreateDaemon. Это хороший пример с использованием MVVM и моментальной валидацией ввода пользовательских данных, который полагается на класс Ui из com.beanexplorer.enterprise.eclipse.jface. Другие примеры можно найти поискав использования Ui.SimpleBinding&lt;T&gt;.addToWizardPage (Ctrl+Shift+G) или других методов Ui.SimpleBinding&lt;T&gt;.<br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.Ui вообще содержит гибкую основу для реализации MVVM UI (примеры можно найти поискав использования класса Ui или его методов). <br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.JFace предоставляет методы для частовстречающихся сценариев (как правило создания виджетов внутри Composite с GridLayout из двух столбцов).<br /> <br /> === События ===<br /> <br /> ==== Автосериализация ====<br /> Начинать смотреть с BeanExplorerProjectProvider.setProject - здесь регистрируются события разные события &quot;codeChanged(SomeClass)&quot; - в конечном счёте они вызывают Serialization.save(SomeClass).<br /> <br /> ==== Автодесериализация ====<br /> Начинасть смотреть с BeanExplorerProjectProvider.setProject - здесь регистрируется &quot;onModify&quot; (статическая функция ON_MODIFY). ON_MODIFY.apply(Path) определяет по пути тип файла и десериализует его. При открытии проекта путь файла регистрируется через project.getAutomaticDeserializationService().registerFile(Path, Type). WatchDir же слушает изменения в файловой системе и отправляет их в onModify.<br /> <br /> ==== Другие события ====<br /> См. различные BeanExplorerProjectProvider.registerLocal(ConcreteListener, Composite). Замечу, что structural change - полезное событие для того, чтобы обновить UI, если изменилось дерево модельных объектов. Изменени модельных объектов не вызывает автоматического перерисования UI - у нас нет такого вида событий!<br /> <br /> === Действия и возможности ===<br /> <br /> ==== Сохранение и открытие проекта ====<br /> BeanExplorerProjectSource - простейший фасад для сохранения и открытия проекта из YAML.<br /> <br /> LegacyBeanExplorerProjectImporter - предоставляет возможность открывать BE3 проект из базы данных.<br /> <br /> ==== JavaScript отладчик ====<br /> com.beanexplorer.enterprise.eclipse.javascript.RunJavaScriptOperationImpl и DebugJavaScriptOperationImpl - основные классы реализации.<br /> <br /> ==== Запуск Query ====<br /> Основывается на Be4QueryExecutor из com.beanexplorer.enterprise.be4core. См. класс &quot;RunQuery&quot; в качестве примера.<br /> <br /> ==== Data Tools Platform: Connection Profiles ====<br /> com.beanexplorer.enterprise.eclipse.model.ConnectionProfiles позволяет преобразовывать наши модельные настройки в DTP connection profile и наоборот.<br /> <br /> ==== Поиск в Project View ====<br /> com.beanexplorer.enterprise.eclipse.jface.DataElementsFilter<br /> <br /> ==== Иконки и подсказки в Project View ====<br /> com.beanexplorer.enterprise.eclipse.views.BeanExplorerProjectViewLabelProvider - вычисляет иконки, рисует простые подсказки и делегирует сложные tooltip'ы (в виде таблиц с ошибками) классу FancyToolTipSupport из того же пакета.<br /> <br /> ==== Сохранение состояния view ====<br /> См. в качестве примера BeanExplorerProjectView.saveState (простейшие примеры - сохранение имени открытого проекта и выделенного элемента) и BeanExplorerProjectView.init (загрузка).<br /> <br /> ==== Настройки ====<br /> См. BeanExplorerPreferencesPage.createFieldEditors и BeanExplorerPreferences из com.beanexplorer.enterprise.eclipse.preferences.BeanExplorerPreferencesPage.<br /> <br /> ==== Фоновые процессы ====<br /> Запуск - new Job(&quot;name&quot;) { implementation }.schedule(). &quot;Подождать&quot; - пример в BeanExplorerProjectProvider.waitForSynchronization, &quot;отменить&quot; - пример в BeanExplorerProjectSource.cancelOpening. Замечу, что любые действия с UI должны делаться в UI потоке, поэтому для запуска кода в UI потоке из Job можно использовать:<br /> * UiFunction.async(function) - оборачивает функцию;<br /> * new AbstractUiSyncFunction&lt;A, R&gt;() { implementation }.apply(arg);<br /> * EclipseUtils.runInUiThread(runnable) или EclipseUtils.runInUiThread(supplier) - асинхронный и синхронный запуск соответственно.<br /> Подолнительно в EclipseUtils имеются методы для показа окошек с ошибками и предупреждениями из не UI потоков (типа openErrorByNonUiThread).<br /> <br /> ==== Утилиты Eclipse ====<br /> EclispeUtils содержит множество полезных методов, относящихся только к Eclipse UI:<br /> * открытие или создание Java класса;<br /> * создание проектов;<br /> * открытие редакторов, view или wizard по идентификатору;<br /> * копирование в буфер обмена;<br /> * получение содержимого редакторов;<br /> * сохранение открытых редакторов.<br /> === Статьи по SWT ===<br /> [http://www.vogella.com/tutorials/SWT/article.html Вот здесь] вводная статья по SWT - объясняются основные концепции, какие виджеты бывают и как используются layout.<br /> <br /> А [http://www.vogella.com/tutorials/EclipseJFaceTable/article.html здесь] статья про JFace - библиотеку, упрощающую работу с таблицами и деревьями.</div>

Asko http://wiki.dote.ru/index.php/%D0%94%D0%BB%D1%8F_%D1%80%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%87%D0%B8%D0%BA%D0%BE%D0%B2_BE4 2014-12-05T09:55:24Z

<p>Asko: </p> <hr /> <div>Здесь будет информация по архитектуре BE4.<br /> <br /> На высоком уровне BE4 состоит из нескольких частей:<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро;<br /> * com.beanexplorer.enterprise.metadata.ant - реализация Ant задач, объявленных в be4/src/be4lib.xml, эти классы не должны использоваться во время исполнения BEclipse;<br /> * com.beanexplorer.enterprise.be4core - класс Be4QueryExecutor, необходимый для запуска Query относительно простым образом без необходимости хранить Query в таблице (в BE3 запуск Query происходит по имени или идентификатору Query в таблице queries, а мы в BE4 работаем только с модельными объектами представленными в виде Java объектов, а не строк в SQL таблицах); используется для запуска Query в BEeclipse и BE5;<br /> * com.beanexplorer.enterprise.eclipse - UI BEclipse и необходимые для его модельные элементы и view model;<br /> * com.beanexplorer.enterprise.api - заготовка фасада для использования простейшего API в тестах: загрузка проекта из папки (projectApi = Facade.load(path)), получение корректного DatabaseConnector (projectApi.getDatabaseConnector()) и запуск Freemarker скриптов (projectApi.runFreemarkerScript(string));<br /> * com.beanexplorer.enterprise.diagrams - здесь и модельные элементы, и UI для диаграмм; новые виды диаграм легче всего добавлять по аналогии со старыми, смотря на уже готовые классы;<br /> * com.beanexplorer.enterprise.planning - здесь [http://ru.wikipedia.org/wiki/Model-View-ViewModel и Model, и ViewModel, и View] для для [[BeanExplorer4#Описание по каждому редактору и view|TasksView]].<br /> <br /> == Ядро ==<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро.<br /> ** exception - все базовые исключения для BE4, мы используем [http://en.wikipedia.org/wiki/Exception_handling#Checked_exceptions checked exceptions].<br /> ** '''model*''' - самое сердце BE4 - модельные объекты, которые представляют собой [[Структура проекта|дерево проекта]], начиная с класса [[Project]].<br /> ** sql - скачивание legacy метаданных (дерева проекта) из BE3 базы данных, синхронизация с базой данных. <br /> ** serialization - сохранённый на жёстком диске BE4 проект представляется как набор YAML файлов; данном пакете реализованы сериализация и десериализация YAML. <br /> ** freemarker - расширение Freemarker, в частности [[Built-ins|Be4BuiltIns]] и [[Встроенные функции|DatabaseFunctions]], [[макросы]] находятся в be4/src/com/beanexplorer/enterprise/metadata/freemarker/macro/common.ftl.<br /> *** FreemarkerSqlHandler - получает на вход FreemarkerScript и запускает его как SQL, переадресуя сгенерированный текст в SqlExecutor.<br /> ** util - базовые полезности; должны находиться в этом пакете, даже если используются только в UI<br /> <br /> == UI ==<br /> Поскольку BEclipse - это плагин для Eclipse, UI реализован классическим способом для Eclipse плагинов. А именно:<br /> * весь основной функционал описан в plugin.xml,<br /> ** это могут быть меню, команды, view, редакторы, wizard, страницы настроек и прочее. Для просмотра всего фунционала открываем plugin.xml на странице &quot;Extensions&quot;.<br /> <br /> === Команды ===<br /> Для создания команды неоходимо зарегистрировать два расширения:<br /> * org.eclipse.ui.commands<br /> * org.eclipse.ui.handlers<br /> Дело в том, что в Eclipse одна и та же команда может быть запущена разными обработчиками, так что команда разделена на две части - собственно command, представляет собой абстрактную команду с именем и описанием, и handler - обработчик, ссылается на класс, реализующий функционал этой команды и указывающий, может ли он в данный момент обработать действие. Например, в Eclipse есть стандартная команда &quot;Debug&quot;. В разных контекстах её обрабатывает разный обработчик - Java код запускается одним способом, а C++ код другим. При этом кнопка на панели инструментов и биндинг постоянно F11 ссылаются на одно и то же действие.<br /> <br /> Наши обработчики команд лежат в com.beanexplorer.enterprise.eclipse.handlers и имеют названия, представляющие собой глаголы.<br /> <br /> Так что для создания новой команды<br /> * кликаем на org.eclipse.ui.commands в нашем редакторе plugin.xml на вкладке Extensions, New -&gt; command, даём уникальный идентификатор, читаемое имя и категорию (categoryId) com.beanexplorer.be4.ui.commands,<br /> * кликаем на org.eclipse.ui.handlers , New -&gt; handler, выбираем только что созданную команду и новый класс из com.beanexplorer.enterprise.eclipse.handlers.<br /> <br /> === Меню ===<br /> Это расширение org.eclipse.ui.menus (New -&gt; menuContribution). Общий вид ссылки на меню (locationURI):<br /> * [menu|popup|toolbar]:&lt;menuOrPartName&gt;[?after=additions]<br /> Здесь &quot;menu&quot;, &quot;popup&quot;, &quot;toolbar&quot; - предопределённые строки. &lt;menuOrPartName&gt; - либо &quot;известное&quot; имя типа org.eclipse.ui.main.menu или org.eclipse.ui.main.toolbar, либо имя редактора или view типа com.beanexplorer.enterprise.eclipse.BeProjectView.<br /> <br /> popup:com.beanexplorer.enterprise.eclipse.BeProjectView - это, в частности, контекстное меню нашего дерева проекта. Для добавления в него новой команды кликаем на надпись &quot;popup:com.beanexplorer.enterprise.eclipse.BeProjectView&quot; (слева в дереве), New -&gt; command, выбираем команды, указываем текст и выбираем иконку. Готово!<br /> <br /> ==== Замечание ====<br /> Для того, чтобы найти класс с реализацией пункта меню, можно найти соответствующий пункт меню в редакторе plugin.xml, в нём будет указана команда, копируем имя команды в строку поиска в редакторе и находим нужный handler.<br /> <br /> === Редакторы и view ===<br /> Хранятся в<br /> * com.beanexplorer.enterprise.eclipse.editors и<br /> * com.beanexplorer.enterprise.eclipse.views соответственно.<br /> Аналогично командам, создаются через редактор, кликаем на com.beanexplorer.enterprise.eclipse.editors, New -&gt; editor, заполняем необходимые поля. Аналогично со view. Замечу, что клик на метку &quot;class&quot; позволяет создать нужный класс (в случае со view это org.eclipse.ui.part.ViewPart, например).<br /> <br /> === Готовые диалоговые окна ===<br /> com.beanexplorer.enterprise.eclipse.dialogs.Dialogs - простые реализации диалоговых окошек, которых не хватает в org.eclipse.jface.dialogs.MessageDialog.<br /> <br /> === MVVM и упрощение написания UI ===<br /> Многие команды представляют собой одностраничные wizard'ы. Вместо того, чтобы писать с нуля, берём класс com.beanexplorer.enterprise.eclipse.handlers.templates.WizardCommandTemplateWizard, копируем в handlers, переименовываем (Alt+Shift+R) и заполняем всё что нужно.<br /> <br /> Хорошей практикой являет написание UI с использованием шаблона проектирования MVVM. Пример - CreateDaemonWizard.CreateDaemonWizardPage из CreateDaemon. Это хороший пример с использованием MVVM и моментальной валидацией ввода пользовательских данных, который полагается на класс Ui из com.beanexplorer.enterprise.eclipse.jface. Другие примеры можно найти поискав использования Ui.SimpleBinding&lt;T&gt;.addToWizardPage (Ctrl+Shift+G) или других методов Ui.SimpleBinding&lt;T&gt;.<br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.Ui вообще содержит гибкую основу для реализации MVVM UI (примеры можно найти поискав использования класса Ui или его методов). <br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.JFace предоставляет методы для частовстречающихся сценариев (как правило создания виджетов внутри Composite с GridLayout из двух столбцов).<br /> <br /> === События ===<br /> <br /> ==== Автосериализация ====<br /> Начинасть смотреть с BeanExplorerProjectProvider.setProject - здесь регистрируются события разные события &quot;codeChanged(SomeClass)&quot; - в конечном счёте они вызывают Serialization.save(SomeClass).<br /> <br /> ==== Автодесериализация ====<br /> Начинасть смотреть с BeanExplorerProjectProvider.setProject - здесь регистрируется &quot;onModify&quot; (статическая функция ON_MODIFY). ON_MODIFY.apply(Path) определяет по пути тип файла и десериализует его. При открытии проекта путь файла регистрируется через project.getAutomaticDeserializationService().registerFile(Path, Type). WatchDir же слушает изменения в файловой системе и отправляет их в onModify.<br /> <br /> ==== Другие события ====<br /> См. различные BeanExplorerProjectProvider.registerLocal(ConcreteListener, Composite). Замечу, что structural change - полезное событие для того, чтобы обновить UI, если изменилось дерево модельных объектов. Изменени модельных объектов не вызывает автоматического перерисования UI - у нас нет такого вида событий!<br /> <br /> === Действия и возможности ===<br /> <br /> ==== Сохранение и открытие проекта ====<br /> BeanExplorerProjectSource - простейший фасад для сохранения и открытия проекта из YAML.<br /> <br /> LegacyBeanExplorerProjectImporter - предоставляет возможность открывать BE3 проект из базы данных.<br /> <br /> ==== JavaScript отладчик ====<br /> com.beanexplorer.enterprise.eclipse.javascript.RunJavaScriptOperationImpl и DebugJavaScriptOperationImpl - основные классы реализации.<br /> <br /> ==== Запуск Query ====<br /> Основывается на Be4QueryExecutor из com.beanexplorer.enterprise.be4core. См. класс &quot;RunQuery&quot; в качестве примера.<br /> <br /> ==== Data Tools Platform: Connection Profiles ====<br /> com.beanexplorer.enterprise.eclipse.model.ConnectionProfiles позволяет преобразовывать наши модельные настройки в DTP connection profile и наоборот.<br /> <br /> ==== Поиск в Project View ====<br /> com.beanexplorer.enterprise.eclipse.jface.DataElementsFilter<br /> <br /> ==== Иконки и подсказки в Project View ====<br /> com.beanexplorer.enterprise.eclipse.views.BeanExplorerProjectViewLabelProvider - вычисляет иконки, рисует простые подсказки и делегирует сложные tooltip'ы (в виде таблиц с ошибками) классу FancyToolTipSupport из того же пакета.<br /> <br /> ==== Сохранение состояния view ====<br /> См. в качестве примера BeanExplorerProjectView.saveState (простейшие примеры - сохранение имени открытого проекта и выделенного элемента) и BeanExplorerProjectView.init (загрузка).<br /> <br /> ==== Настройки ====<br /> См. BeanExplorerPreferencesPage.createFieldEditors и BeanExplorerPreferences из com.beanexplorer.enterprise.eclipse.preferences.BeanExplorerPreferencesPage.<br /> <br /> ==== Фоновые процессы ====<br /> Запуск - new Job(&quot;name&quot;) { implementation }.schedule(). &quot;Подождать&quot; - пример в BeanExplorerProjectProvider.waitForSynchronization, &quot;отменить&quot; - пример в BeanExplorerProjectSource.cancelOpening. Замечу, что любые действия с UI должны делаться в UI потоке, поэтому для запуска кода в UI потоке из Job можно использовать:<br /> * UiFunction.async(function) - оборачивает функцию;<br /> * new AbstractUiSyncFunction&lt;A, R&gt;() { implementation }.apply(arg);<br /> * EclipseUtils.runInUiThread(runnable) или EclipseUtils.runInUiThread(supplier) - асинхронный и синхронный запуск соответственно.<br /> Подолнительно в EclipseUtils имеются методы для показа окошек с ошибками и предупреждениями из не UI потоков (типа openErrorByNonUiThread).<br /> <br /> ==== Утилиты Eclipse ====<br /> EclispeUtils содержит множество полезных методов, относящихся только к Eclipse UI:<br /> * открытие или создание Java класса;<br /> * создание проектов;<br /> * открытие редакторов, view или wizard по идентификатору;<br /> * копирование в буфер обмена;<br /> * получение содержимого редакторов;<br /> * сохранение открытых редакторов.<br /> === Статьи по SWT ===<br /> [http://www.vogella.com/tutorials/SWT/article.html Вот здесь] вводная статья по SWT - объясняются основные концепции, какие виджеты бывают и как используются layout.<br /> <br /> А [http://www.vogella.com/tutorials/EclipseJFaceTable/article.html здесь] статья про JFace - библиотеку, упрощающую работу с таблицами и деревьями.</div>

Asko http://wiki.dote.ru/index.php/%D0%94%D0%BB%D1%8F_%D1%80%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%87%D0%B8%D0%BA%D0%BE%D0%B2_BE4 2014-12-05T09:38:55Z

<p>Asko: </p> <hr /> <div>Здесь будет информация по архитектуре BE4.<br /> <br /> На высоком уровне BE4 состоит из нескольких частей:<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро;<br /> * com.beanexplorer.enterprise.metadata.ant - реализация Ant задач, объявленных в be4/src/be4lib.xml, эти классы не должны использоваться во время исполнения BEclipse;<br /> * com.beanexplorer.enterprise.be4core - класс Be4QueryExecutor, необходимый для запуска Query относительно простым образом без необходимости хранить Query в таблице (в BE3 запуск Query происходит по имени или идентификатору Query в таблице queries, а мы в BE4 работаем только с модельными объектами представленными в виде Java объектов, а не строк в SQL таблицах); используется для запуска Query в BEeclipse и BE5;<br /> * com.beanexplorer.enterprise.eclipse - UI BEclipse и необходимые для его модельные элементы и view model;<br /> * com.beanexplorer.enterprise.api - заготовка фасада для использования простейшего API в тестах: загрузка проекта из папки (projectApi = Facade.load(path)), получение корректного DatabaseConnector (projectApi.getDatabaseConnector()) и запуск Freemarker скриптов (projectApi.runFreemarkerScript(string));<br /> * com.beanexplorer.enterprise.diagrams - здесь и модельные элементы, и UI для диаграмм; новые виды диаграм легче всего добавлять по аналогии со старыми, смотря на уже готовые классы;<br /> * com.beanexplorer.enterprise.planning - здесь [http://ru.wikipedia.org/wiki/Model-View-ViewModel и Model, и ViewModel, и View] для для [[BeanExplorer4#Описание по каждому редактору и view|TasksView]].<br /> <br /> == Ядро ==<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро.<br /> ** exception - все базовые исключения для BE4, мы используем [http://en.wikipedia.org/wiki/Exception_handling#Checked_exceptions checked exceptions].<br /> ** '''model*''' - самое сердце BE4 - модельные объекты, которые представляют собой [[Структура проекта|дерево проекта]], начиная с класса [[Project]].<br /> ** sql - скачивание legacy метаданных (дерева проекта) из BE3 базы данных, синхронизация с базой данных. <br /> ** serialization - сохранённый на жёстком диске BE4 проект представляется как набор YAML файлов; данном пакете реализованы сериализация и десериализация YAML. <br /> ** freemarker - расширение Freemarker, в частности [[Built-ins|Be4BuiltIns]] и [[Встроенные функции|DatabaseFunctions]], [[макросы]] находятся в be4/src/com/beanexplorer/enterprise/metadata/freemarker/macro/common.ftl.<br /> *** FreemarkerSqlHandler - получает на вход FreemarkerScript и запускает его как SQL, переадресуя сгенерированный текст в SqlExecutor.<br /> ** util - базовые полезности; должны находиться в этом пакете, даже если используются только в UI<br /> <br /> == UI ==<br /> Поскольку BEclipse - это плагин для Eclipse, UI реализован классическим способом для Eclipse плагинов. А именно:<br /> * весь основной функционал описан в plugin.xml,<br /> ** это могут быть меню, команды, view, редакторы, wizard, страницы настроек и прочее. Для просмотра всего фунционала открываем plugin.xml на странице &quot;Extensions&quot;.<br /> <br /> === Команды ===<br /> Для создания команды неоходимо зарегистрировать два расширения:<br /> * org.eclipse.ui.commands<br /> * org.eclipse.ui.handlers<br /> Дело в том, что в Eclipse одна и та же команда может быть запущена разными обработчиками, так что команда разделена на две части - собственно command, представляет собой абстрактную команду с именем и описанием, и handler - обработчик, ссылается на класс, реализующий функционал этой команды и указывающий, может ли он в данный момент обработать действие. Например, в Eclipse есть стандартная команда &quot;Debug&quot;. В разных контекстах её обрабатывает разный обработчик - Java код запускается одним способом, а C++ код другим. При этом кнопка на панели инструментов и биндинг постоянно F11 ссылаются на одно и то же действие.<br /> <br /> Наши обработчики команд лежат в com.beanexplorer.enterprise.eclipse.handlers и имеют названия, представляющие собой глаголы.<br /> <br /> Так что для создания новой команды<br /> * кликаем на org.eclipse.ui.commands в нашем редакторе plugin.xml на вкладке Extensions, New -&gt; command, даём уникальный идентификатор, читаемое имя и категорию (categoryId) com.beanexplorer.be4.ui.commands,<br /> * кликаем на org.eclipse.ui.handlers , New -&gt; handler, выбираем только что созданную команду и новый класс из com.beanexplorer.enterprise.eclipse.handlers.<br /> <br /> === Меню ===<br /> Это расширение org.eclipse.ui.menus (New -&gt; menuContribution). Общий вид ссылки на меню (locationURI):<br /> * [menu|popup|toolbar]:&lt;menuOrPartName&gt;[?after=additions]<br /> Здесь &quot;menu&quot;, &quot;popup&quot;, &quot;toolbar&quot; - предопределённые строки. &lt;menuOrPartName&gt; - либо &quot;известное&quot; имя типа org.eclipse.ui.main.menu или org.eclipse.ui.main.toolbar, либо имя редактора или view типа com.beanexplorer.enterprise.eclipse.BeProjectView.<br /> <br /> popup:com.beanexplorer.enterprise.eclipse.BeProjectView - это, в частности, контекстное меню нашего дерева проекта. Для добавления в него новой команды кликаем на надпись &quot;popup:com.beanexplorer.enterprise.eclipse.BeProjectView&quot; (слева в дереве), New -&gt; command, выбираем команды, указываем текст и выбираем иконку. Готово!<br /> <br /> ==== Замечание ====<br /> Для того, чтобы найти класс с реализацией пункта меню, можно найти соответствующий пункт меню в редакторе plugin.xml, в нём будет указана команда, копируем имя команды в строку поиска в редакторе и находим нужный handler.<br /> <br /> === Редакторы и view ===<br /> Хранятся в<br /> * com.beanexplorer.enterprise.eclipse.editors и<br /> * com.beanexplorer.enterprise.eclipse.views соответственно.<br /> Аналогично командам, создаются через редактор, кликаем на com.beanexplorer.enterprise.eclipse.editors, New -&gt; editor, заполняем необходимые поля. Аналогично со view. Замечу, что клик на метку &quot;class&quot; позволяет создать нужный класс (в случае со view это org.eclipse.ui.part.ViewPart, например).<br /> <br /> === Готовые диалоговые окна ===<br /> com.beanexplorer.enterprise.eclipse.dialogs.Dialogs - простые реализации диалоговых окошек, которых не хватает в org.eclipse.jface.dialogs.MessageDialog.<br /> <br /> === MVVM и упрощение написания UI ===<br /> Многие команды представляют собой одностраничные wizard'ы. Вместо того, чтобы писать с нуля, берём класс com.beanexplorer.enterprise.eclipse.handlers.templates.WizardCommandTemplateWizard, копируем в handlers, переименовываем (Alt+Shift+R) и заполняем всё что нужно.<br /> <br /> Хорошей практикой являет написание UI с использованием шаблона проектирования MVVM. Пример - CreateDaemonWizard.CreateDaemonWizardPage из CreateDaemon. Это хороший пример с использованием MVVM и моментальной валидацией ввода пользовательских данных, который полагается на класс Ui из com.beanexplorer.enterprise.eclipse.jface. Другие примеры можно найти поискав использования Ui.SimpleBinding&lt;T&gt;.addToWizardPage (Ctrl+Shift+G) или других методов Ui.SimpleBinding&lt;T&gt;.<br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.Ui вообще содержит гибкую основу для реализации MVVM UI (примеры можно найти поискав использования класса Ui или его методов). <br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.JFace предоставляет методы для частовстречающихся сценариев (как правило создания виджетов внутри Composite с GridLayout из двух столбцов).<br /> <br /> === События ===<br /> <br /> ==== Автосериализация ====<br /> Начинасть смотреть с BeanExplorerProjectProvider.setProject - здесь регистрируются события разные события &quot;codeChanged(SomeClass)&quot; - в конечном счёте они вызывают Serialization.save(SomeClass).<br /> <br /> ==== Автодесериализация ====<br /> Начинасть смотреть с BeanExplorerProjectProvider.setProject - здесь регистрируется &quot;onModify&quot; (статическая функция ON_MODIFY). ON_MODIFY.apply(Path) определяет по пути тип файла и десериализует его. При открытии проекта путь файла регистрируется через project.getAutomaticDeserializationService().registerFile(Path, Type). WatchDir же слушает изменения в файловой системе и отправляет их в onModify.<br /> <br /> ==== Другие события ====<br /> См. различные BeanExplorerProjectProvider.registerLocal(ConcreteListener, Composite). Замечу, что structural change - полезное событие для того, чтобы обновить UI, если изменилось дерево модельных объектов. Изменени модельных объектов не вызывает автоматического перерисования UI - у нас нет такого вида событий!<br /> <br /> === Действия и возможности ===<br /> <br /> ==== Сохранение и открытие проекта ====<br /> BeanExplorerProjectSource - простейший фасад для сохранения и открытия проекта из YAML.<br /> <br /> LegacyBeanExplorerProjectImporter - предоставляет возможность открывать BE3 проект из базы данных.<br /> <br /> ==== JavaScript отладчик ====<br /> com.beanexplorer.enterprise.eclipse.javascript.RunJavaScriptOperationImpl и DebugJavaScriptOperationImpl - основные классы реализации.<br /> <br /> ==== Запуск Query ====<br /> Основывается на Be4QueryExecutor из com.beanexplorer.enterprise.be4core. См. класс &quot;RunQuery&quot; в качестве примера.<br /> <br /> ==== Data Tools Platform: Connection Profiles ====<br /> com.beanexplorer.enterprise.eclipse.model.ConnectionProfiles позволяет преобразовывать наши модельные настройки в DTP connection profile и наоборот.<br /> <br /> ==== Поиск в Project View ====<br /> com.beanexplorer.enterprise.eclipse.jface.DataElementsFilter<br /> <br /> ==== Иконки и подсказки в Project View ====<br /> com.beanexplorer.enterprise.eclipse.views.BeanExplorerProjectViewLabelProvider - вычисляет иконки, рисует простые подсказки и делегирует сложные tooltip'ы (в виде таблиц с ошибками) классу FancyToolTipSupport из того же пакета.<br /> <br /> ==== Сохранение состояния view ====<br /> См. в качестве примера BeanExplorerProjectView.saveState (простейшие примеры - сохранение имени открытого проекта и выделенного элемента) и BeanExplorerProjectView.init (загрузка).<br /> <br /> ==== Настройки ====<br /> См. BeanExplorerPreferencesPage.createFieldEditors и BeanExplorerPreferences из com.beanexplorer.enterprise.eclipse.preferences.BeanExplorerPreferencesPage.<br /> <br /> === Статьи по SWT ===<br /> [http://www.vogella.com/tutorials/SWT/article.html Вот здесь] вводная статья по SWT - объясняются основные концепции, какие виджеты бывают и как используются layout.<br /> <br /> А [http://www.vogella.com/tutorials/EclipseJFaceTable/article.html здесь] статья про JFace - библиотеку, упрощающую работу с таблицами и деревьями.</div>

Asko http://wiki.dote.ru/index.php/%D0%94%D0%BB%D1%8F_%D1%80%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%87%D0%B8%D0%BA%D0%BE%D0%B2_BE4 2014-12-05T09:34:34Z

<p>Asko: </p> <hr /> <div>Здесь будет информация по архитектуре BE4.<br /> <br /> На высоком уровне BE4 состоит из нескольких частей:<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро;<br /> * com.beanexplorer.enterprise.metadata.ant - реализация Ant задач, объявленных в be4/src/be4lib.xml, эти классы не должны использоваться во время исполнения BEclipse;<br /> * com.beanexplorer.enterprise.be4core - класс Be4QueryExecutor, необходимый для запуска Query относительно простым образом без необходимости хранить Query в таблице (в BE3 запуск Query происходит по имени или идентификатору Query в таблице queries, а мы в BE4 работаем только с модельными объектами представленными в виде Java объектов, а не строк в SQL таблицах); используется для запуска Query в BEeclipse и BE5;<br /> * com.beanexplorer.enterprise.eclipse - UI BEclipse и необходимые для его модельные элементы и view model;<br /> * com.beanexplorer.enterprise.api - заготовка фасада для использования простейшего API в тестах: загрузка проекта из папки (projectApi = Facade.load(path)), получение корректного DatabaseConnector (projectApi.getDatabaseConnector()) и запуск Freemarker скриптов (projectApi.runFreemarkerScript(string));<br /> * com.beanexplorer.enterprise.diagrams - здесь и модельные элементы, и UI для диаграмм; новые виды диаграм легче всего добавлять по аналогии со старыми, смотря на уже готовые классы;<br /> * com.beanexplorer.enterprise.planning - здесь [http://ru.wikipedia.org/wiki/Model-View-ViewModel и Model, и ViewModel, и View] для для [[BeanExplorer4#Описание по каждому редактору и view|TasksView]].<br /> <br /> == Ядро ==<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро.<br /> ** exception - все базовые исключения для BE4, мы используем [http://en.wikipedia.org/wiki/Exception_handling#Checked_exceptions checked exceptions].<br /> ** '''model*''' - самое сердце BE4 - модельные объекты, которые представляют собой [[Структура проекта|дерево проекта]], начиная с класса [[Project]].<br /> ** sql - скачивание legacy метаданных (дерева проекта) из BE3 базы данных, синхронизация с базой данных. <br /> ** serialization - сохранённый на жёстком диске BE4 проект представляется как набор YAML файлов; данном пакете реализованы сериализация и десериализация YAML. <br /> ** freemarker - расширение Freemarker, в частности [[Built-ins|Be4BuiltIns]] и [[Встроенные функции|DatabaseFunctions]], [[макросы]] находятся в be4/src/com/beanexplorer/enterprise/metadata/freemarker/macro/common.ftl.<br /> *** FreemarkerSqlHandler - получает на вход FreemarkerScript и запускает его как SQL, переадресуя сгенерированный текст в SqlExecutor.<br /> ** util - базовые полезности; должны находиться в этом пакете, даже если используются только в UI<br /> <br /> == UI ==<br /> Поскольку BEclipse - это плагин для Eclipse, UI реализован классическим способом для Eclipse плагинов. А именно:<br /> * весь основной функционал описан в plugin.xml,<br /> ** это могут быть меню, команды, view, редакторы, wizard, страницы настроек и прочее. Для просмотра всего фунционала открываем plugin.xml на странице &quot;Extensions&quot;.<br /> <br /> === Команды ===<br /> Для создания команды неоходимо зарегистрировать два расширения:<br /> * org.eclipse.ui.commands<br /> * org.eclipse.ui.handlers<br /> Дело в том, что в Eclipse одна и та же команда может быть запущена разными обработчиками, так что команда разделена на две части - собственно command, представляет собой абстрактную команду с именем и описанием, и handler - обработчик, ссылается на класс, реализующий функционал этой команды и указывающий, может ли он в данный момент обработать действие. Например, в Eclipse есть стандартная команда &quot;Debug&quot;. В разных контекстах её обрабатывает разный обработчик - Java код запускается одним способом, а C++ код другим. При этом кнопка на панели инструментов и биндинг постоянно F11 ссылаются на одно и то же действие.<br /> <br /> Наши обработчики команд лежат в com.beanexplorer.enterprise.eclipse.handlers и имеют названия, представляющие собой глаголы.<br /> <br /> Так что для создания новой команды<br /> * кликаем на org.eclipse.ui.commands в нашем редакторе plugin.xml на вкладке Extensions, New -&gt; command, даём уникальный идентификатор, читаемое имя и категорию (categoryId) com.beanexplorer.be4.ui.commands,<br /> * кликаем на org.eclipse.ui.handlers , New -&gt; handler, выбираем только что созданную команду и новый класс из com.beanexplorer.enterprise.eclipse.handlers.<br /> <br /> === Меню ===<br /> Это расширение org.eclipse.ui.menus (New -&gt; menuContribution). Общий вид ссылки на меню (locationURI):<br /> * [menu|popup|toolbar]:&lt;menuOrPartName&gt;[?after=additions]<br /> Здесь &quot;menu&quot;, &quot;popup&quot;, &quot;toolbar&quot; - предопределённые строки. &lt;menuOrPartName&gt; - либо &quot;известное&quot; имя типа org.eclipse.ui.main.menu или org.eclipse.ui.main.toolbar, либо имя редактора или view типа com.beanexplorer.enterprise.eclipse.BeProjectView.<br /> <br /> popup:com.beanexplorer.enterprise.eclipse.BeProjectView - это, в частности, контекстное меню нашего дерева проекта. Для добавления в него новой команды кликаем на надпись &quot;popup:com.beanexplorer.enterprise.eclipse.BeProjectView&quot; (слева в дереве), New -&gt; command, выбираем команды, указываем текст и выбираем иконку. Готово!<br /> <br /> ==== Замечание ====<br /> Для того, чтобы найти класс с реализацией пункта меню, можно найти соответствующий пункт меню в редакторе plugin.xml, в нём будет указана команда, копируем имя команды в строку поиска в редакторе и находим нужный handler.<br /> <br /> === Редакторы и view ===<br /> Хранятся в<br /> * com.beanexplorer.enterprise.eclipse.editors и<br /> * com.beanexplorer.enterprise.eclipse.views соответственно.<br /> Аналогично командам, создаются через редактор, кликаем на com.beanexplorer.enterprise.eclipse.editors, New -&gt; editor, заполняем необходимые поля. Аналогично со view. Замечу, что клик на метку &quot;class&quot; позволяет создать нужный класс (в случае со view это org.eclipse.ui.part.ViewPart, например).<br /> <br /> === Готовые диалоговые окна ===<br /> com.beanexplorer.enterprise.eclipse.dialogs.Dialogs - простые реализации диалоговых окошек, которых не хватает в org.eclipse.jface.dialogs.MessageDialog.<br /> <br /> === MVVM и упрощение написания UI ===<br /> Многие команды представляют собой одностраничные wizard'ы. Вместо того, чтобы писать с нуля, берём класс com.beanexplorer.enterprise.eclipse.handlers.templates.WizardCommandTemplateWizard, копируем в handlers, переименовываем (Alt+Shift+R) и заполняем всё что нужно.<br /> <br /> Хорошей практикой являет написание UI с использованием шаблона проектирования MVVM. Пример - CreateDaemonWizard.CreateDaemonWizardPage из CreateDaemon. Это хороший пример с использованием MVVM и моментальной валидацией ввода пользовательских данных, который полагается на класс Ui из com.beanexplorer.enterprise.eclipse.jface. Другие примеры можно найти поискав использования Ui.SimpleBinding&lt;T&gt;.addToWizardPage (Ctrl+Shift+G) или других методов Ui.SimpleBinding&lt;T&gt;.<br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.Ui вообще содержит гибкую основу для реализации MVVM UI (примеры можно найти поискав использования класса Ui или его методов). <br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.JFace предоставляет методы для частовстречающихся сценариев (как правило создания виджетов внутри Composite с GridLayout из двух столбцов).<br /> <br /> === События ===<br /> <br /> ==== Автосериализация ====<br /> Начинасть смотреть с BeanExplorerProjectProvider.setProject - здесь регистрируются события разные события &quot;codeChanged(SomeClass)&quot; - в конечном счёте они вызывают Serialization.save(SomeClass).<br /> <br /> ==== Автодесериализация ====<br /> Начинасть смотреть с BeanExplorerProjectProvider.setProject - здесь регистрируется &quot;onModify&quot; (статическая функция ON_MODIFY). ON_MODIFY.apply(Path) определяет по пути тип файла и десериализует его. При открытии проекта путь файла регистрируется через project.getAutomaticDeserializationService().registerFile(Path, Type). WatchDir же слушает изменения в файловой системе и отправляет их в onModify.<br /> <br /> ==== Другие события ====<br /> См. различные BeanExplorerProjectProvider.registerLocal(ConcreteListener, Composite). Замечу, что structural change - полезное событие для того, чтобы обновить UI, если изменилось дерево модельных объектов. Изменени модельных объектов не вызывает автоматического перерисования UI - у нас нет такого вида событий!<br /> <br /> === Действия и возможности ===<br /> <br /> ==== Сохранение и открытие проекта ====<br /> BeanExplorerProjectSource - простейший фасад для сохранения и открытия проекта из YAML.<br /> <br /> LegacyBeanExplorerProjectImporter - предоставляет возможность открывать BE3 проект из базы данных.<br /> <br /> ==== JavaScript отладчик ====<br /> com.beanexplorer.enterprise.eclipse.javascript.RunJavaScriptOperationImpl и DebugJavaScriptOperationImpl - основные классы реализации.<br /> <br /> ==== Запуск Query ====<br /> Основывается на Be4QueryExecutor из com.beanexplorer.enterprise.be4core. См. класс &quot;RunQuery&quot; в качестве примера.<br /> <br /> ==== Data Tools Platform: Connection Profiles ====<br /> com.beanexplorer.enterprise.eclipse.model.ConnectionProfiles позволяет преобразовывать наши модельные настройки в DTP connection profile и наоборот.<br /> <br /> ==== Поиск в Project View ====<br /> com.beanexplorer.enterprise.eclipse.jface.DataElementsFilter<br /> <br /> ==== Иконки и подсказки в Project View ====<br /> com.beanexplorer.enterprise.eclipse.views.BeanExplorerProjectViewLabelProvider - вычисляет иконки, рисует простые подсказки и делегирует сложные tooltip'ы (в виде таблиц с ошибками) классу FancyToolTipSupport из того же пакета.<br /> <br /> === Статьи по SWT ===<br /> [http://www.vogella.com/tutorials/SWT/article.html Вот здесь] вводная статья по SWT - объясняются основные концепции, какие виджеты бывают и как используются layout.<br /> <br /> А [http://www.vogella.com/tutorials/EclipseJFaceTable/article.html здесь] статья про JFace - библиотеку, упрощающую работу с таблицами и деревьями.</div>

Asko http://wiki.dote.ru/index.php/%D0%94%D0%BB%D1%8F_%D1%80%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%87%D0%B8%D0%BA%D0%BE%D0%B2_BE4 2014-12-05T09:01:40Z

<p>Asko: /* MVVM и упрощение написания UI */</p> <hr /> <div>Здесь будет информация по архитектуре BE4.<br /> <br /> На высоком уровне BE4 состоит из нескольких частей:<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро;<br /> * com.beanexplorer.enterprise.metadata.ant - реализация Ant задач, объявленных в be4/src/be4lib.xml, эти классы не должны использоваться во время исполнения BEclipse;<br /> * com.beanexplorer.enterprise.be4core - класс Be4QueryExecutor, необходимый для запуска Query относительно простым образом без необходимости хранить Query в таблице (в BE3 запуск Query происходит по имени или идентификатору Query в таблице queries, а мы в BE4 работаем только с модельными объектами представленными в виде Java объектов, а не строк в SQL таблицах); используется для запуска Query в BEeclipse и BE5;<br /> * com.beanexplorer.enterprise.eclipse - UI BEclipse и необходимые для его модельные элементы и view model;<br /> * com.beanexplorer.enterprise.api - заготовка фасада для использования простейшего API в тестах: загрузка проекта из папки (projectApi = Facade.load(path)), получение корректного DatabaseConnector (projectApi.getDatabaseConnector()) и запуск Freemarker скриптов (projectApi.runFreemarkerScript(string));<br /> * com.beanexplorer.enterprise.diagrams - здесь и модельные элементы, и UI для диаграмм; новые виды диаграм легче всего добавлять по аналогии со старыми, смотря на уже готовые классы;<br /> * com.beanexplorer.enterprise.planning - здесь [http://ru.wikipedia.org/wiki/Model-View-ViewModel и Model, и ViewModel, и View] для для [[BeanExplorer4#Описание по каждому редактору и view|TasksView]].<br /> <br /> == Ядро ==<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро.<br /> ** exception - все базовые исключения для BE4, мы используем [http://en.wikipedia.org/wiki/Exception_handling#Checked_exceptions checked exceptions].<br /> ** '''model*''' - самое сердце BE4 - модельные объекты, которые представляют собой [[Структура проекта|дерево проекта]], начиная с класса [[Project]].<br /> ** sql - скачивание legacy метаданных (дерева проекта) из BE3 базы данных, синхронизация с базой данных. <br /> ** serialization - сохранённый на жёстком диске BE4 проект представляется как набор YAML файлов; данном пакете реализованы сериализация и десериализация YAML. <br /> ** freemarker - расширение Freemarker, в частности [[Built-ins|Be4BuiltIns]] и [[Встроенные функции|DatabaseFunctions]], [[макросы]] находятся в be4/src/com/beanexplorer/enterprise/metadata/freemarker/macro/common.ftl.<br /> *** FreemarkerSqlHandler - получает на вход FreemarkerScript и запускает его как SQL, переадресуя сгенерированный текст в SqlExecutor.<br /> ** util - базовые полезности; должны находиться в этом пакете, даже если используются только в UI<br /> <br /> == UI ==<br /> Поскольку BEclipse - это плагин для Eclipse, UI реализован классическим способом для Eclipse плагинов. А именно:<br /> * весь основной функционал описан в plugin.xml,<br /> ** это могут быть меню, команды, view, редакторы, wizard, страницы настроек и прочее. Для просмотра всего фунционала открываем plugin.xml на странице &quot;Extensions&quot;.<br /> <br /> === Команды ===<br /> Для создания команды неоходимо зарегистрировать два расширения:<br /> * org.eclipse.ui.commands<br /> * org.eclipse.ui.handlers<br /> Дело в том, что в Eclipse одна и та же команда может быть запущена разными обработчиками, так что команда разделена на две части - собственно command, представляет собой абстрактную команду с именем и описанием, и handler - обработчик, ссылается на класс, реализующий функционал этой команды и указывающий, может ли он в данный момент обработать действие. Например, в Eclipse есть стандартная команда &quot;Debug&quot;. В разных контекстах её обрабатывает разный обработчик - Java код запускается одним способом, а C++ код другим. При этом кнопка на панели инструментов и биндинг постоянно F11 ссылаются на одно и то же действие.<br /> <br /> Наши обработчики команд лежат в com.beanexplorer.enterprise.eclipse.handlers и имеют названия, представляющие собой глаголы.<br /> <br /> Так что для создания новой команды<br /> * кликаем на org.eclipse.ui.commands в нашем редакторе plugin.xml на вкладке Extensions, New -&gt; command, даём уникальный идентификатор, читаемое имя и категорию (categoryId) com.beanexplorer.be4.ui.commands,<br /> * кликаем на org.eclipse.ui.handlers , New -&gt; handler, выбираем только что созданную команду и новый класс из com.beanexplorer.enterprise.eclipse.handlers.<br /> <br /> === Меню ===<br /> Это расширение org.eclipse.ui.menus (New -&gt; menuContribution). Общий вид ссылки на меню (locationURI):<br /> * [menu|popup|toolbar]:&lt;menuOrPartName&gt;[?after=additions]<br /> Здесь &quot;menu&quot;, &quot;popup&quot;, &quot;toolbar&quot; - предопределённые строки. &lt;menuOrPartName&gt; - либо &quot;известное&quot; имя типа org.eclipse.ui.main.menu или org.eclipse.ui.main.toolbar, либо имя редактора или view типа com.beanexplorer.enterprise.eclipse.BeProjectView.<br /> <br /> popup:com.beanexplorer.enterprise.eclipse.BeProjectView - это, в частности, контекстное меню нашего дерева проекта. Для добавления в него новой команды кликаем на надпись &quot;popup:com.beanexplorer.enterprise.eclipse.BeProjectView&quot; (слева в дереве), New -&gt; command, выбираем команды, указываем текст и выбираем иконку. Готово!<br /> <br /> ==== Замечание ====<br /> Для того, чтобы найти класс с реализацией пункта меню, можно найти соответствующий пункт меню в редакторе plugin.xml, в нём будет указана команда, копируем имя команды в строку поиска в редакторе и находим нужный handler.<br /> <br /> === Редакторы и view ===<br /> Хранятся в<br /> * com.beanexplorer.enterprise.eclipse.editors и<br /> * com.beanexplorer.enterprise.eclipse.views соответственно.<br /> Аналогично командам, создаются через редактор, кликаем на com.beanexplorer.enterprise.eclipse.editors, New -&gt; editor, заполняем необходимые поля. Аналогично со view. Замечу, что клик на метку &quot;class&quot; позволяет создать нужный класс (в случае со view это org.eclipse.ui.part.ViewPart, например).<br /> <br /> === Готовые диалоговые окна ===<br /> com.beanexplorer.enterprise.eclipse.dialogs.Dialogs - простые реализации диалоговых окошек, которых не хватает в org.eclipse.jface.dialogs.MessageDialog.<br /> <br /> === MVVM и упрощение написания UI ===<br /> Многие команды представляют собой одностраничные wizard'ы. Вместо того, чтобы писать с нуля, берём класс com.beanexplorer.enterprise.eclipse.handlers.templates.WizardCommandTemplateWizard, копируем в handlers, переименовываем (Alt+Shift+R) и заполняем всё что нужно.<br /> <br /> Хорошей практикой являет написание UI с использованием шаблона проектирования MVVM. Пример - CreateDaemonWizard.CreateDaemonWizardPage из CreateDaemon. Это хороший пример с использованием MVVM и моментальной валидацией ввода пользовательских данных, который полагается на класс Ui из com.beanexplorer.enterprise.eclipse.jface. Другие примеры можно найти поискав использования Ui.SimpleBinding&lt;T&gt;.addToWizardPage (Ctrl+Shift+G) или других методов Ui.SimpleBinding&lt;T&gt;.<br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.Ui вообще содержит гибкую основу для реализации MVVM UI (примеры можно найти поискав использования класса Ui или его методов). <br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.JFace предоставляет методы для частовстречающихся сценариев (как правило создания виджетов внутри Composite с GridLayout из двух столбцов).<br /> <br /> === Статьи по SWT ===<br /> [http://www.vogella.com/tutorials/SWT/article.html Вот здесь] вводная статья по SWT - объясняются основные концепции, какие виджеты бывают и как используются layout.<br /> <br /> А [http://www.vogella.com/tutorials/EclipseJFaceTable/article.html здесь] статья про JFace - библиотеку, упрощающую работу с таблицами и деревьями.</div>

Asko http://wiki.dote.ru/index.php/%D0%94%D0%BB%D1%8F_%D1%80%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%87%D0%B8%D0%BA%D0%BE%D0%B2_BE4 2014-12-05T08:58:46Z

<p>Asko: </p> <hr /> <div>Здесь будет информация по архитектуре BE4.<br /> <br /> На высоком уровне BE4 состоит из нескольких частей:<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро;<br /> * com.beanexplorer.enterprise.metadata.ant - реализация Ant задач, объявленных в be4/src/be4lib.xml, эти классы не должны использоваться во время исполнения BEclipse;<br /> * com.beanexplorer.enterprise.be4core - класс Be4QueryExecutor, необходимый для запуска Query относительно простым образом без необходимости хранить Query в таблице (в BE3 запуск Query происходит по имени или идентификатору Query в таблице queries, а мы в BE4 работаем только с модельными объектами представленными в виде Java объектов, а не строк в SQL таблицах); используется для запуска Query в BEeclipse и BE5;<br /> * com.beanexplorer.enterprise.eclipse - UI BEclipse и необходимые для его модельные элементы и view model;<br /> * com.beanexplorer.enterprise.api - заготовка фасада для использования простейшего API в тестах: загрузка проекта из папки (projectApi = Facade.load(path)), получение корректного DatabaseConnector (projectApi.getDatabaseConnector()) и запуск Freemarker скриптов (projectApi.runFreemarkerScript(string));<br /> * com.beanexplorer.enterprise.diagrams - здесь и модельные элементы, и UI для диаграмм; новые виды диаграм легче всего добавлять по аналогии со старыми, смотря на уже готовые классы;<br /> * com.beanexplorer.enterprise.planning - здесь [http://ru.wikipedia.org/wiki/Model-View-ViewModel и Model, и ViewModel, и View] для для [[BeanExplorer4#Описание по каждому редактору и view|TasksView]].<br /> <br /> == Ядро ==<br /> * '''com.beanexplorer.enterprise.metadata*''' - ядро.<br /> ** exception - все базовые исключения для BE4, мы используем [http://en.wikipedia.org/wiki/Exception_handling#Checked_exceptions checked exceptions].<br /> ** '''model*''' - самое сердце BE4 - модельные объекты, которые представляют собой [[Структура проекта|дерево проекта]], начиная с класса [[Project]].<br /> ** sql - скачивание legacy метаданных (дерева проекта) из BE3 базы данных, синхронизация с базой данных. <br /> ** serialization - сохранённый на жёстком диске BE4 проект представляется как набор YAML файлов; данном пакете реализованы сериализация и десериализация YAML. <br /> ** freemarker - расширение Freemarker, в частности [[Built-ins|Be4BuiltIns]] и [[Встроенные функции|DatabaseFunctions]], [[макросы]] находятся в be4/src/com/beanexplorer/enterprise/metadata/freemarker/macro/common.ftl.<br /> *** FreemarkerSqlHandler - получает на вход FreemarkerScript и запускает его как SQL, переадресуя сгенерированный текст в SqlExecutor.<br /> ** util - базовые полезности; должны находиться в этом пакете, даже если используются только в UI<br /> <br /> == UI ==<br /> Поскольку BEclipse - это плагин для Eclipse, UI реализован классическим способом для Eclipse плагинов. А именно:<br /> * весь основной функционал описан в plugin.xml,<br /> ** это могут быть меню, команды, view, редакторы, wizard, страницы настроек и прочее. Для просмотра всего фунционала открываем plugin.xml на странице &quot;Extensions&quot;.<br /> <br /> === Команды ===<br /> Для создания команды неоходимо зарегистрировать два расширения:<br /> * org.eclipse.ui.commands<br /> * org.eclipse.ui.handlers<br /> Дело в том, что в Eclipse одна и та же команда может быть запущена разными обработчиками, так что команда разделена на две части - собственно command, представляет собой абстрактную команду с именем и описанием, и handler - обработчик, ссылается на класс, реализующий функционал этой команды и указывающий, может ли он в данный момент обработать действие. Например, в Eclipse есть стандартная команда &quot;Debug&quot;. В разных контекстах её обрабатывает разный обработчик - Java код запускается одним способом, а C++ код другим. При этом кнопка на панели инструментов и биндинг постоянно F11 ссылаются на одно и то же действие.<br /> <br /> Наши обработчики команд лежат в com.beanexplorer.enterprise.eclipse.handlers и имеют названия, представляющие собой глаголы.<br /> <br /> Так что для создания новой команды<br /> * кликаем на org.eclipse.ui.commands в нашем редакторе plugin.xml на вкладке Extensions, New -&gt; command, даём уникальный идентификатор, читаемое имя и категорию (categoryId) com.beanexplorer.be4.ui.commands,<br /> * кликаем на org.eclipse.ui.handlers , New -&gt; handler, выбираем только что созданную команду и новый класс из com.beanexplorer.enterprise.eclipse.handlers.<br /> <br /> === Меню ===<br /> Это расширение org.eclipse.ui.menus (New -&gt; menuContribution). Общий вид ссылки на меню (locationURI):<br /> * [menu|popup|toolbar]:&lt;menuOrPartName&gt;[?after=additions]<br /> Здесь &quot;menu&quot;, &quot;popup&quot;, &quot;toolbar&quot; - предопределённые строки. &lt;menuOrPartName&gt; - либо &quot;известное&quot; имя типа org.eclipse.ui.main.menu или org.eclipse.ui.main.toolbar, либо имя редактора или view типа com.beanexplorer.enterprise.eclipse.BeProjectView.<br /> <br /> popup:com.beanexplorer.enterprise.eclipse.BeProjectView - это, в частности, контекстное меню нашего дерева проекта. Для добавления в него новой команды кликаем на надпись &quot;popup:com.beanexplorer.enterprise.eclipse.BeProjectView&quot; (слева в дереве), New -&gt; command, выбираем команды, указываем текст и выбираем иконку. Готово!<br /> <br /> ==== Замечание ====<br /> Для того, чтобы найти класс с реализацией пункта меню, можно найти соответствующий пункт меню в редакторе plugin.xml, в нём будет указана команда, копируем имя команды в строку поиска в редакторе и находим нужный handler.<br /> <br /> === Редакторы и view ===<br /> Хранятся в<br /> * com.beanexplorer.enterprise.eclipse.editors и<br /> * com.beanexplorer.enterprise.eclipse.views соответственно.<br /> Аналогично командам, создаются через редактор, кликаем на com.beanexplorer.enterprise.eclipse.editors, New -&gt; editor, заполняем необходимые поля. Аналогично со view. Замечу, что клик на метку &quot;class&quot; позволяет создать нужный класс (в случае со view это org.eclipse.ui.part.ViewPart, например).<br /> <br /> === Готовые диалоговые окна ===<br /> com.beanexplorer.enterprise.eclipse.dialogs.Dialogs - простые реализации диалоговых окошек, которых не хватает в org.eclipse.jface.dialogs.MessageDialog.<br /> <br /> === MVVM и упрощение написания UI ===<br /> Многие команды представляют собой одностраничные wizard'ы. Вместо того, чтобы писать с нуля, берём класс com.beanexplorer.enterprise.eclipse.handlers.templates.WizardCommandTemplateWizard, копируем в handlers, переименовываем (Alt+Shift+R) и заполняем всё что нужно.<br /> <br /> Хорошей практикой являет написание UI с использованием шаблона проектирования MVVM. Пример - CreateDaemonWizard.CreateDaemonWizardPage из CreateDaemon. Это хороший пример с использованием MVVM и моментальной валидацией ввода пользовательских данных, который полагается на класс Ui из com.beanexplorer.enterprise.eclipse.jface. Другие примеры можно найти поискав использования Ui.SimpleBinding&lt;T&gt;.addToWizardPage (Ctrl+Shift+G).<br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.Ui вообще содержит гибкую основу для реализации MVVM UI (примеры можно найти поискав использования класса Ui или его методов). <br /> <br /> Класс com.beanexplorer.enterprise.eclipse.jface.JFace предоставляет методы для частовстречающихся сценариев (как правило создания виджетов внутри Composite с GridLayout из двух столбцов).<br /> <br /> === Статьи по SWT ===<br /> [http://www.vogella.com/tutorials/SWT/article.html Вот здесь] вводная статья по SWT - объясняются основные концепции, какие виджеты бывают и как используются layout.<br /> <br /> А [http://www.vogella.com/tutorials/EclipseJFaceTable/article.html здесь] статья про JFace - библиотеку, упрощающую работу с таблицами и деревьями.</div>

Asko