Liferay7开发文档_1.2作为开发平台

25-03-18 8

关于Liferay7开发文档_1.2作为开发平台的问题就给大家分享到这里，感谢你花时间阅读本站内容，更多关于entfrm开发平台，一个免费开源可视化的无代码开发平台、idehub云端软件开发平台与We

关于Liferay7开发文档_1.2作为开发平台的问题就给大家分享到这里，感谢你花时间阅读本站内容，更多关于entfrm 开发平台，一个免费开源可视化的无代码开发平台、idehub云端软件开发平台与Web开发平台 Eclipse Orion介绍、JNPF快速开发平台-快速开发Web+APP项目的java开发平台、layuiadmin(iframe）开发文档等相关知识的信息别忘了在本站进行查找喔。

本文目录一览：

Liferay7开发文档_1.2作为开发平台
entfrm 开发平台，一个免费开源可视化的无代码开发平台
idehub云端软件开发平台与Web开发平台 Eclipse Orion介绍
JNPF快速开发平台-快速开发Web+APP项目的java开发平台
layuiadmin(iframe）开发文档

Liferay7开发文档_1.2作为开发平台

LIFERAY作为开发平台

如果你读了前面的内容，应该了解了Liferay Portal的架构，模块化和技术。下面将讲讲如何通过Liferay平台自定义或开发来创建网站。

WEB应用程序和PORTLET

作为一个开发平台，Liferay可在一个页面轻松部署多个应用程序，这为管理员和开发人员提供了灵活性。以这种方式编写的应用程序称为portlet，这是Liferay平台的支柱。您可以使用Liferay的MVC Portlet框架或Spring MVC或JSF等通用框架编写portlet。如果您打算为您的应用程序提供基于Web的界面，并且希望管理员能够灵活配置，Portlet提供了非常强大的模型。您可以创建多个portlet而不是更庞大的应用程序，让管理员选择如何将它们与其之前的portlet在界面上组合。

你也有其他选择。Liferay将其业务逻辑从它的UI（由单独模块提供）解耦，所以可自由选择其他UI技术实现。

可以将Liferay作为Headless平台使用，你可以利用Service Builder快速创建JAX-RS和JAX-WS的Web服务。然后用任何喜欢的前端技术或移动技术构建独立应用。

可扩展性

正如您所想，上述系统包含了架构良好系统的必需工具，该系统允许开发人员不仅可以创建基于模块的应用程序，还可以扩展系统现有功能。

组件使开发扩展和自定义变得方便。如果您将此模型与其他产品进行比较，您会看到它的便利性。

要定制现有服务，您需要做的唯一事情就是部署一个组件。如果你想删除你的实现并恢复到默认行为，你只需解除部署你的组件。

将其与传统的软件开发模式比较。

每次软件更新时，您都必须重新下载源代码，重新应用您的修补程序并重新编译软件。

使用Liferay，您的自定义代码将保存在您自己的模块中，容器根据您提供的元数据来处理这些模块。

开发者工具

Liferay的OSGi容器为你提供了这些好处：

容器可以启动和停止组件。
一个组件实现一个OSGi服务。
组件可直接使用或调用OSGi服务。
该框架管理组件所调用的服务绑定（就像Spring或EJB一样，但是动态的）。

听起来都很棒，剩下的只有一件事：你如何开始开发组件？我们为新手提供了一条轻松途径，同时为有工具偏好的老手保留了灵活性。Liferay提供了一些很好的工具，如果你是一位经验丰富的开发人员，这些工具也可以整合到现有工具中。如果您使用标准构建工具（如Gradle或Maven），文本编辑器或以及Java IDE（如Eclipse，intelliJ或NetBeans）或测试框架（如Spock或JUnit），可以让它们与Liferay一起协作。

Liferay的工具提供了一些重要的增强功能：

Blade CLI通过从模板创建基于Gradle的Liferay项目。
Liferay Workspace是基于Gradle的自定义SDK，它使用Blade CLI将项目和运行时集成到一个便捷，可分发和可共享的区域。
Liferay IDE是一个Eclipse的开发环境，它将Blade CLI和Liferay Workspace的所有功能集成到一个最佳图形环境中。
Liferay Developer Studio提供Liferay IDE提供的所有功能，以及企业开发人员需要的附加工具。
Liferay Service Builder通过从单个XML文件生成所有数据库表，本地服务和Web服务，帮助您更快地创建后端。

您可以选择使用或忽略Liferay的工具。这很灵活，因为Liferay提供了一个开放的开发框架。我们反对专有和捆绑，因此我们的工具旨在补充，而不是替换。

除了构建工具和IDE之外，您将使用应用程序开发框架。Liferay的开发框架包括许多功能（评论，社交关系，用户管理等等），以加快应用程序的开发。它们可帮助您从提供充分测试的，现代，可扩展，可换肤开发模块搭建应用程序。您的应用程序不仅功能强大，还可以花费更少的时间，并且工作良好。这并不意味着你仅限于Liferay提供的内容; 如果您喜欢使用，完全可以使用第三方框架。

为了开发portlet，Liferay提供了一个方便且易于使用的框架，名为MVCPortlet，使编写portlet变得简单，但开发人员可以使用任何其他框架（如Spring MVC）来创建portlet。MVCPortlet使用组件来处理请求，受益于上述所有特性（生命周期，可扩展性，易于组合等）。

Liferay还包括一个名为Service Builder的实用工具，它可以方便地创建后端数据库表、用于访问它们的Java对象关系映射，以及放置业务逻辑的位置。它还可以生成JSON或SOAP web服务，为开发人员提供使用web或移动客户端存储和检索数据的完整堆栈。但这并不妨碍您使用Java Persistence (JPA)并生成JAX-WS web服务。

除了工具之外，Liferay还提供了许多可重用框架。

框架和API

Liferay的开发平台为应用程序开发提供了一个很好的框架，并提供API。很多情况下。应用程序可以通过利用Liferay的框架来创建，这些框架封装了应用程序常见功能。例如，评论系统允许开发人员对他们定义的任何资产附加评论，不管他们新开发的，还是系统自带的资产。资产由系统共享，用于表示许多常见元素，例如用户，组织，站点，用户组，博客条目，甚至文件夹和文件。

Liferay还包括许多用于资产运营的框架。工作流可以轻松创建需要审批流程的应用程序。回收站在指定的时间段内存储已删除的资产，无需管理员的干预即可轻松恢复数据。具有多个可用后端的文件存储API使存储和共享文件简单到不值一提。搜索也内置于系统中，并且为与其应用程序集成做了专门设计。开发复杂应用程序时所需的许多框架已经存在; 您只需要利用它们：社交网络API，带有数据列表的用户生成表单，消息总线，审计系统等等。

LIFERAY项目示例

是时候练习了。展示Liferay开发风格的好方法是通过一些项目。首先，您将看到一个使用MVCPortlet开发的portlet，并展示组件的使用。下一个是extension扩展。这两个示例都向您展示了遵循模块化范例构建功能的容易程度。

很高兴向您展示标准的Hello World项目，Liferay风格，但这太容易了：Blade或Liferay IDE创建的默认模板已经默认使用该模板。您会看到Hello You portlet。除了将用户的名字添加到消息之外，它与Hello World的功能相同。如果你的名字因此是John，它会返回Hello, John。

以下是Project结构：

你好，你的portlet-layout.png

Hello You portlet有一个简单的项目结构。

此项目由Liferay的Blade CLI工具生成后，没有创建任何新文件，所以这个过程非常简单。你定义的portlet类在.java文件中。您还有两种不同的资源：language properties和JSP文件。最后，该bnd.bnd文件描述了OSGi容器的应用程序元数据，并且该build.gradle文件构建了该项目。

任何熟悉Java的Web开发人员都可以理解这些JSP，但是由于风格的原因，有些解释是有序的。这里定义了一个init.jsp文件，包含前端所需的所有 imports和tag库初始化代码。这样，任何JSP都可以简单包含init.jsp，声明所有imports。该init.jsp看起来像这样：

<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>

<%@ taglib uri="http://java.sun.com/portlet\_2\_0" prefix="portlet" %>

<%@ taglib uri="http://liferay.com/tld/aui" prefix="aui" %>

<%@ taglib uri="http://liferay.com/tld/portlet" prefix="liferay-portlet" %>

<%@ taglib uri="http://liferay.com/tld/theme" prefix="liferay-theme" %>

<%@ taglib uri="http://liferay.com/tld/ui" prefix="liferay-ui" %>

<liferay-theme:defineObjects />

<portlet:defineObjects />

它所做的只是声明你可能想要使用的tag库，然后调用一些tags来使portlet框架中的对象可用。

你还需要看下view.jsp：

<%@ include file="/init.jsp" %>

<jsp:useBean id="userName" type="java.lang.String" scope="request" />

<p>

    <b>Hello, <%=userName %>!</b>

</p>

现在我们有了一些东西。portlet类（以MVC术语来说，Controller）在请求中提取一个名为userName的字符串，提供给JSP，并用它向用户打招呼。因此，真正的功能在portlet类中：

@Component(
    immediate = true,
    property = {
        "com.liferay.portlet.display-category=category.sample",
        "com.liferay.portlet.instanceable=true",
        "javax.portlet.display-name=hello-you Portlet",
        "javax.portlet.init-param.template-path=/",
        "javax.portlet.init-param.view-template=/view.jsp",
        "javax.portlet.resource-bundle=content.Language",
        "javax.portlet.security-role-ref=power-user,user"
    },
    service = Portlet.class
)
public class HelloYouPortlet extends MVCPortlet {

    @Override
    public void render(RenderRequest renderRequest, 
                    RenderResponse renderResponse)
            throws IOException, PortletException
    {
        ThemeDisplay themeDisplay = (ThemeDisplay)
                    renderRequest.getAttribute(WebKeys.THEME\_DISPLAY);

        User user = themeDisplay.getUser();

        renderRequest.setAttribute("userName", 
                    user.getFirstName());



        super.render(renderRequest, renderResponse);
    }

}

顶部是@Component注释，它告诉OSGi容器应该如何处理这个模块。指定immediate=true，表示当部署了这个模块并且它的所有依赖都满足时，它应该立即启动，而不是被延迟加载。接下来是几个特定于portlet的属性：在Liferay的用户界面中显示的类别，显示名称，默认视图等。最后，定义服务实现（只是一个Java接口），这是个portlet类。

这个类扩展了Liferay的MVCPortlet类（延伸GenericPortlet，实现Portlet）。唯一重写的render()方法，Liferay的API用于获取用户的名字并将其放入一个名为request的属性中userName。

您看到它是如何工作的：portlet运行并提取用户的名字，将其放入request请求中，然后通过使用@Component注释中指定的模板路径和视图模板属性将处理转发到view.jsp用户的第一个名称被获取并显示。

有趣是bnd.bnd文件：

Bundle-SymbolicName: com.liferay.docs.hello.you
Bundle-Version: 1.0.0

这声明了module模块的名称（有时也称为bundle包）。为了避免容器中的命名冲突，正确定义命名空间是一种好做法。该版本也需要声明，允许容器管理模块版本级别的依赖关系。这称为语义版本控制，是一个重要讨论话题。

这就是这个portlet的全部。接下来，您将看到一个extension扩展，在许多情况下，它比portlet更简单。

Liferay的用户界面分为几个区域。有控制菜单和产品菜单，其中包含添加菜单和模拟菜单。如果你想扩展UI，你可以通过部署一个可以添加你想要的模块来实现。在本例中，您将添加一个链接到产品菜单，该菜单默认位于浏览器的右上角：

产品菜单unchanged.png

为此，将添加一个站点链接：

产品选单与 - link.png

您可以通过部署组件来在产品菜单的添加链接。

与portlet一样，该工程布局易于理解。

产品菜单项目layout.png

和前面一样，你有一个构建脚本，一个声明模块名称和版本的bnd.bnd文件，一个Java类和一个语言属性文件。

Java类只定义了四个方法：

@Component(
    immediate = true,
    property = {
        "product.navigation.control.menu.category.key=" +
                 ProductNavigationControlMenuCategoryKeys.USER,
        "product.navigation.control.menu.entry.order:Integer=1"
    },
    service = ProductNavigationControlMenuEntry.class
)
public class DevProductNavigationControlMenuEntry
    extends BaseProductNavigationControlMenuEntry
    implements ProductNavigationControlMenuEntry {

    @Override
    public String getIcon(HttpServletRequest request) {

        return "link";
    }

    @Override
    public String getLabel(Locale locale) {

        ResourceBundle resourceBundle = ResourceBundleUtil.getBundle(
            "content.Language", locale, getClass());

        return LanguageUtil.get(resourceBundle, "custom-message");
    }

    @Override
    public String getURL(HttpServletRequest request) {

        return "https://dev.liferay.com";

    }

    @Override
    public boolean isShow(HttpServletRequest request) throws 
        PortalException {

        return true;
    }

}

如前所述，此工程是Blade CLI通过模板生成的。源代码是模板的一部分; 你需要做的唯一事情就是提供链接。

第一种方法获取您想要在菜单中使用的Font Awesome icon图标。接下来得到“label”，即用户将鼠标悬停在链接上时显示的文本。该文本在Language.properties文件中的唯一属性值：

custom-message=Liferay Developer Network

下一个方法返回这个链接的目标URL，最后的方法返回一个布尔值来显示或隐藏链接。

部署此模块时，链接将在模块启动时添加到菜单中。您不必在Liferay的JSP或JavaScript文件中查找来自定义菜单：它是一个扩展点，它被设计为自定义。

这是模块化开发范例。它可以帮助保持代码的清晰分离，无论是应用程序还是扩展，都来自默认发布的代码，并且可以让您在运行时动态自更新，以避免停机。这是一种不同的模式，当你开始使用模块并获得的好处时，我们认为你会同意这是一种很好的模式。

entfrm 开发平台，一个免费开源可视化的无代码开发平台

简介

entfrm 开发平台，是一个以模块化为核心的无代码开发平台，是一个集 PC 和 APP 快速开发、系统管理、运维监控、开发工具、OAuth2 授权、可视化数据源管理与数据构建、API 动态生成与统计、工作流、智能表单设计、微服务等全方位功能于一体的高效、稳定的快速开发平台。平台采用 Spring Boot 2.X 、Spring Security、Oauth2、Mybatis Plus、Activiti、uni-app 等核心技术，前端基于 vue-element-admin 框架。

功能思维导图

功能特色

1. 模块化

丰富的模块稳定的框架后台极易上手目前已包括系统管理、任务调度、运维监控、开发工具、消息系统、工作流引擎、内容管理等模块

2. 无代码开发

强大的 API 接口构建器测试与文档一步到位创表、代码生成即刻开发，快速配置与自定义接口分秒接入，权限控制、统计报表等一个都不能少

3. 工作流

可视化动态流程清晰流程直观展示模型管理，流程定义，提供图形化流程设计界面，所见即所得；还有企业级专业流程引擎等您咨询

4. 表单引擎

像 “乐高” 一样，拖拽式设计表单多端适配拖拽式快速设计表单，PC、Pad、手机多端适配，还有 uni-app 集成，一次开发多端分发

5. 微服务

可单体可集群敏捷开发分散治理 spring-cloud，spring-cloud-alibaba 商业级分布式微服务架构

6. 开放的生态

插件、模块、成品尽在应用中心构建开放生态开发的插件、模块、成品可发布到应用中心，定价销售，让您多一份兼职收入

APP 效果

登录界面	消息界面	我的界面

Web 效果

首页界面	应用管理

Redis 监控	定时任务

服务监控	数据表构建

接口构建	工作流

idehub.cn是 idehub推出的一款基于浏览器的云端软件开发平台。

它类似于在浏览器上运行 Eclipse，是一个完全等同于本地eclipse开发环境的云端ide平台，支持java，c++，php等开发语言。

完全实现本地化eclipse平台和云端开发环境的无缝衔接。

并且通过git服务，可以无缝接入其他代码托管平台，为开发者提供真正的云端软件开发环境。

Orion 是 Eclipse 组织推出的一款基于浏览器的Web开发平台。这并不是说在浏览器上运行 Eclipse，而是一个完全新开发的工具集成和工作流，适合Web开发而非桌面。特别是JavaScript、HTML5 以及 CSS。

下载后运行 eclipse.exe 将启动一个 HTTP 服务器，端口8080，用浏览器访问这个端口，注册一个新帐号就可以进入 Orion 平台。

JNPF快速开发平台-快速开发Web+APP项目的java开发平台

JNPF快速开发平台

JNPF快速开发平台采用前后端分离技术、采用B/S架构开发，形成一站式开发多端（APP+PC）使用。

JAVA版介绍

java版采用前后端分离，前端项目与后端项目是两个项目，需要独立部署，两个不同的工程，两个不同的代码库，前端通过 ajax 来调用 http 请求调用后端的 restful api。

JNPF架构体系

=========

主体架构

JNPF快速开发平台采用前后端分离技术、采用B/S架构开发，形成一站式开发多端（APP+PC）使用, 实现统一的权限管理、灵活的接口调用、拖拽式流程搭建等操作，使用业界领先地位的研发技术体系。

JNPF开发环境

前端

Vue2.x；ElementUI；Axios；WebScoket；

后端

SpringBoot、SpringCloud、Mybatis、Maven、.NET Core3.1、Ocelot、EFCore、Nuget；

移动端

Android、IOS、微信小程序、混合应用、uniapp；

数据库

Oracle、SQLServer、MySQL；

JNPF特点

拖拉、可视化设计表单

我们采用所见即所得的表单设计方式，通过简单的拖拽控件及数据绑定设置即可完成表单设计工作。因此，通过我们提供的表单设计器，您不需要专业的电脑知识，即可在几分钟内设计出非常专业的表单。设计出来的所有表单都是标准的表单，具有良好的互操作性和可扩展性，并且兼容所有的主流浏览器。

丰富的表单控件

内置100+控件，通过组装设计表单，满足95%以上常规业务需求；支持通用开发模板、单表开发模板、多表开发模板、流程表单模板、移动开发模板等类型的控件，表单设计时可以直接使用内置的表单控件，也可以使用第三方控件，同时支持自开发控件，满足特有需求。

强大的APP开发能力

APP快速开发功能，各种APP中的组件如标题、文本框、各种类型的列表、按钮都能够进行拖拽式开发，并可在页面板块中进行各种组件和页面的颜色、主题、尺寸、图标等样式的设置和按钮的连接设置。使得普通的开发人员也可以基于JNPF敏捷开发框架进行 APP开发了，不用再支付高额的工资聘请安卓和 IOS 开发人员。

通过以上各类配置信息，可以实现对业务模块代码的完全掌控，实现自己需要实现的需求功能，而且在进行初始化配置信息时，通过可视化的配置列的属性是否为主键字段，是否为下拉框字段，有需要调整的字段进行对应调整即可，大部分可配置信息均为下拉列表，直接选取即可，简单、快速、高效，自由自在，实现所想。

突破每张表单个主键限制

大部分自动代码生成框架只能处理单表，并且每张表只能有一个主键，才能保证持久化操作，而JNPF开发平台突破了这一限制，你可以根据业务需求任意定义自己的表，可以有联合主键，自动生成的代码会自动根据表中的所有主键进行持久化操作，不存在代码绑架需求的情况，使得JNPF可以支持更为复杂多样的业务需求。

外部数据源接入

电子化的表单不同于纸张上的表单，特别是关键业务使用的表单，数据之间有极大地关联性，通常这些数据还存储在不同系统中，如ERP、HR。 JNPF表单解决方案提供外部数据接入功能，您可以根据需要，将来自各不同系统的数据体现在表单中。

高度原生态

JNPF开发平台生成的代码均为原生代码，没有进行任何特殊性封装，只要使用过主体框架相关技术的开发人员，对生成的代码不会产生任何的迷茫，可以保证能够看到懂，改的对。

系统响应迅速

JNPF开发平台因为采用原生态代码生成策略，没有进行任何复杂的封装，同时把引用文件个数保持在最低，并对代码进行了优化整理，所有生成的代码规范统一，保证系统整体响应迅速流畅。

layuiadmin(iframe）开发文档

题外该文档适用于 layuiAdmin 专业版（单页面），阅读之前请务必确认是否与你使用的版本对应。熟练掌握 layuiAdmin 的前提是熟练掌握 layui，因此除了本篇文档， layui 的文档也是必不可少的存在。

快速上手

部署解压文件后，将 layuiAdmin 完整放置在任意目录通过本地 web 服务器去访问 ./start/index.html 即可运行 Demo 由于 layuiAdmin 可采用前后端分离开发模式，因此你无需将其放置在你的服务端 MVC 框架中，你只需要给 layuiAdmin 主入口页面（我们也称之为：宿主页面）进行访问解析，它即可全权完成自身路由的跳转和视图的呈现，而数据层则完全通过服务端提供的异步接口来完成。

目录说明 src/ layuiAdmin 源代码，通常用于开发环境（如本地），推荐你在本地开发时，将 ./start/index.html 中的 layui.css 和 layui.js 的引入路径由 dist 改为 src 目录。

src/controller/：存放 JS 业务模块，即对视图进行事件等交互性处理 src/lib/：layuiAdmin 的核心模块，一般不推荐修改 src/style/：存放样式，其中 admin.css是核心样式 src/views/：存放视图文件。其中 layout.html 是整个框架结构的承载，一般不推荐做大量改动。 src/config.js：layuiAdmin 的全局配置文件，可随意修改。 src/index.js：layuiAdmin 的入口模块，一般不推荐修改 dist/ 通过 gulp 将 layuiAdmin src 目录的源代码进行构建后生成的目录（即：将 JS 和 CSS 文件进行了压缩等处理），通常用于线上环境。关于 gulp 的使用，下文也有介绍。

start/ 存放 layuiAdmin 的入口页面、模拟接口数据、layui

宿主页面你所看到的 start/index.html 是我们提供好的宿主页面，它是整个单页面的承载，所有的界面都是在这一个页面中完成跳转和渲染的。事实上，宿主页面可以放在任何地方，但是要注意修改里面的 <link> <script> 的 src 和 layui.config 中 base 的路径。

全局配置当你已经顺利在本地预览了 layuiAdmin 后，你一定迫不及待关注更深层的结构。打开 src 目录，你将看到 config.js，里面存储着所有的默认配置。你可以按照实际需求选择性修改，下面是 layuiAdmin 默认提供的配置：

layui.define([''laytpl'', ''layer'', ''element'', ''util''], function(exports){ exports(''setter'', { container: ''LAY_app'' //容器ID ,base: layui.cache.base //记录layuiAdmin文件夹所在路径 ,views: layui.cache.base + ''views/'' //视图所在目录 ,entry: ''index'' //默认视图文件名 ,engine: ''.html'' //视图文件后缀名 ,pageTabs: false //是否开启页面选项卡功能。单页版不推荐开启

,name: ''layuiAdmin Pro''
,tableName: ''layuiAdmin'' //本地存储表名
,MOD_NAME: ''admin'' //模块事件名

,debug: true //是否开启调试模式。如开启，接口异常时会抛出异常 URL 等信息

,interceptor: false //是否开启未登入拦截

//自定义请求字段
,request: {
  tokenName: ''access_token'' //自动携带 token 的字段名。可设置 false 不携带。
}

//自定义响应字段
,response: {
  statusName: ''code'' //数据状态的字段名称
  ,statusCode: {
    ok: 0 //数据状态一切正常的状态码
    ,logout: 1001 //登录状态失效的状态码
  }
  ,msgName: ''msg'' //状态信息的字段名称
  ,dataName: ''data'' //数据详情的字段名称
}

//独立页面路由，可随意添加（无需写参数）
,indPage: [
  ''/user/login'' //登入页
  ,''/user/reg'' //注册页
  ,''/user/forget'' //找回密码
  ,''/template/tips/test'' //独立页的一个测试 demo
]

//扩展的第三方模块
,extend: [
  ''echarts'', //echarts 核心包
  ''echartsTheme'' //echarts 主题
]

//主题配置
,theme: {
  //配色方案，如果用户未设置主题，第一个将作为默认
  color: [{
    main: ''#20222A'' //主题色
    ,selected: ''#009688'' //选中色
    ,logo: '''' //logo区域背景色
    ,header: '''' //头部区域背景色
    ,alias: ''default'' //默认别名
  }] //为了减少篇幅，更多主题此处不做列举，可直接参考 config.js

  //初始的颜色索引，对应上面的配色方案数组索引
  //如果本地已经有主题色记录，则以本地记录为优先，除非清除 localStorage（步骤：F12呼出调试工具→Aplication→Local Storage→选中页面地址→layuiAdmin→再点上面的X）
  // 1.0 正式版开始新增
  ,initColorIndex: 0
}

}); });

侧边菜单在 start/json/menu.js 文件中，我们放置了默认的侧边菜单数据，你可以去随意改动它。如果你需要动态加载菜单，你需要将 views/layout.html 中的对应地址改成你的真实接口地址侧边菜单最多可支持到三级。无论你采用静态的菜单还是动态的，菜单的数据格式都必须是一段合法的 JSON，且必须符合以下规范：

{ "code": 0 //状态码，key 名可以通过 config.js 去重新配置 ,"msg": "" //提示信息 ,"data": [{ //菜单数据，key名可以通过 config.js 去重新配置 "name": "component" //一级菜单名称（与视图的文件夹名称和路由路径对应） ,"title": "组件" //一级菜单标题 ,"icon": "layui-icon-component" //一级菜单图标样式 ,"jump": '''' //自定义一级菜单路由地址，默认按照 name 解析。一旦设置，将优先按照 jump 设定的路由跳转 ,"spread": true //是否默认展子菜单（1.0.0-beta9 新增） ,"list": [{ //二级菜单 "name": "grid" //二级菜单名称（与视图的文件夹名称和路由路径对应） ,"title": "栅格" //二级菜单标题 ,"jump": '''' //自定义二级菜单路由地址 ,"spread": true //是否默认展子菜单（1.0.0-beta9 新增） ,"list": [{ //三级菜单 "name": "list" //三级菜单名（与视图中最终的文件名和路由对应），如：component/grid/list ,"title": "等比例列表排列" //三级菜单标题 },{ "name": "mobile" ,"title": "按移动端排列" } }] } TIPS：实际运用时，切勿出现上述中的注释，否则将不是合法的 JSON ，会出现解析错误。

需要注意的是以下几点：

当任意级菜单有子菜单，点击该菜单都只是收缩和展开操作，而并不会跳转，只有没有子菜单的菜单才被允许跳转。菜单的路由地址默认是按照菜单层级的 name 来设定的。我们假设一级菜单的 name 是：a，二级菜单的是：b，三级菜单的 name 是 c，那么：三级菜单最终的路由地址就是：/a/b/c 如果二级菜单没有三级菜单，那么二级菜单就是最终路由，地址就是：/a/b/ 如果一级菜单没有二级菜单，那么一级菜单就是最终路由，地址就是：/a/ 但如果你设置了参数 jump，那么就会优先读取 jump 设定的路由地址，如："jump": "/user/set"

路由 layuiAdmin 的路由是采用 location.hash 的机制，即路由地址是放在 ./#/ 后面，并通过 layui 自带的方法： layui.router() 来进行解析。每一个路由都对应一个真实存在的视图文件，且路由地址和视图文件的路径是一致的（相对 views 目录）。因此，你不再需要通过配置服务端的路由去访问一个页面，也无需在 layuiAdmin 内部代码中去定义路由，而是直接通过 layuiAdmin 的前端路由去访问，即可匹配相应目录的视图，从而呈现出页面结果。

路由规则 ./#/path1/path2/path3/key1=value1/key2=value2… 一个实际的示例：

./#/user/set ./#/user/set/uid=123/type=1#xxx（下面将以这个为例继续讲解）当你需要对路由结构进行解析时，你只需要通过 layui 内置的方法 layui.router() 即可完成。如上面的路由解析出来的结果是：

{ path: [''user'',''set''] ,search: {uid: 123, type: 1} ,href: ''user/set/uid=123/type=1'' ,hash: ''xxx'' } 可以看到，不同的结构会自动归纳到相应的参数中，其中：

path：存储的是路由的目录结构 search：存储的是路由的参数部分 href：存储的是 layuiAdmin 的完整路由地址 hash：存储的是 layuiAdmin 自身的锚记，跟系统自带的 location.hash 有点类似通过 layui.router() 得到路由对象后，你就可以对页面进行个性化操作、异步参数传值等等。如：

//在 JS 中获取路由参数 var router = layui.router(); admin.req({ url: ''xxx'' ,data: { uid: router.search.uid } });

路由跳转通过上文的路由规则，你已经大致清楚了 layuiAdmin 路由的基本原理和解析方法。那么如何完成路由的跳转呢？

在视图文件的 HTML 代码中，通过对任意元素设定 lay-href="/user/set/uid=123/type=1" ，好处是：任意元素都可以触发跳转。缺点是：只能在浏览器当前选项卡完成跳转（注意：不是 layuiAdmin 的选项卡）直接对 a 标签设定 href，如： <a href="#/user/set">text</a> 。好处是：你可以通过设定 target="_blank" 来打开一个浏览器新选项卡。缺点是：只能设置 a 标签，且前面必须加 /#/ 在 JS 代码中，还可通过 location.hash = ''/user/set''; 来跳转。前面无需加 #，它会自动追加。

路由结尾在路由结尾部分出现的 / 与不出现，是两个完全不同的路由。比如下面这个：

user/set 读取的视图文件是：.views/user/set.html user/set/ 读取的视图文件是：./views/user/set/index.html （TIPS：这里的 index.html 即是目录下的默认主视图，下文会有讲解）因此一定要注意结尾处的 /，避免视图读取错误。

视图这或许是你应用 layuiAdmin 时的主要焦点，在开发过程中，你的大部分精力都可能会聚焦在这里。它取代了服务端 MVC 架构中的 view 层，使得应用开发变得更具扩展性。因此如果你采用 layuiAdmin 的 SPA（单页应用）模式，请务必要抛弃服务端渲染视图的思想，让页面的控制权限重新回归到前端吧！

views 目录存放的正是视图文件，你可以在该目录添加任意的新目录和新文件，通过对应的路由即可访问。

注意：如果是单页面模式，视图文件通常是一段 HTML 碎片，而不能是一个完整的 html 代码结构。

视图与路由的关系每一个视图文件，都对应一个路由。其中 index.html 是默认文件（你也可以通过 config.js 去重新定义）。视图文件的所在目录决定了路由的访问地址，如：

视图路径对应的路由地址 ./views/user/index.html /user/ ./views/user.html /user ./views/user/set/index.html /user/set/ ./views/user/set.html /user/set ./views/user/set/base.html /user/set/base 通过上述的表格列举的对应关系，可以总结出：

当视图文件是 index.html，那么路由地址就是它的上级目录（相对 views），以 / 结尾当视图文件不是 index.html，那么路由地址就是它的上级目录+视图文件名，不以 / 结尾值得注意的是：路由路径并非最多只能三级，它可以无限极。但对应的视图也必须存放在相应的层级目录下

视图中加载 JS 模块在视图文件中，除了写 HTML，也可以写 JavaScript 代码。如：

<div id=“LAY-demo-hello”>Hello layuiAdmin</div> <script> layui.use(''admin'', function(){ var $ = layui.jquery; admin.popup({ content: $(''#LAY-demo-hello'').html() }); }); </script> 如果该视图对应的 JS 代码量太大，我们更推荐你在 controller 目录下新增一个业务模块，并在视图中直接 layui.use 去加载该模块。下面以控制台主页 index.html 为例：

<div>html区域<div>

当视图被渲染后，layui.factory 返回的函数也会被执行，从而保证在不重复加载 JS 模块文件的前提下，保证脚本能重复执行。

动态模板 layuiAdmin 的视图是一个“动静结合”的载体，除了常规的静态模板，你当然还可以在视图中存放动态模板，因此它可谓是焦点中的焦点。

定义模板在视图文件中，通过下述规则定义模板：

下面是一个简单的例子：

在不对动态模板设定数据接口地址的情况下，它能读取到全局对象。但更多时候，一个动态模板应该是对应一个接口地址，如下所示：

模板中的 d 对应的是你接口返回的 json 转化后的一维对象，如：

{ "code": 0 ,"data": { "username": "贤心" ,"sex": "男" } } 那么，上述动态模板最终输出的结果就是：

我叫：贤心公的

模板基础属性动态模板支持以下基础属性

lay-url 用于绑定模板的数据接口地址，支持动态模板解析，如：

lay-type 用于设定模板的接口请求类型（默认：get），如：

lay-data 用于定义接口请求的参数，其值是一个 JavaScript object 对象，同样支持动态模板解析，如：

lay-headers 用户定义接口请求的 Request Headers 参数，用法与 lay-data 的完全类似，支持动态模板解析。

lay-done 接口请求完毕并完成视图渲染的回调脚本，里面支持写任意的 JavaScript 语句。事实上它是一个封闭的函数作用域，通过给 Function 实例返回的函数传递一个参数 d，用于得到接口返回的数据：

很多时候，你在动态模板中可能会放入一些类似于 layui 的 form 元素，而有些控件需要执行 form.render() 才会显示，这时，你可以对 lay-done 赋值一个全局函数，如：

TIPS：

如果模板渲染完毕需要处理过多的交互，我们强烈推荐你采用上述的方式定义一个全局函数赋值给 lay-done，会极大地减少维护成本。无需担心该全局函数的冲突问题，该函数是一次性的。其它页面即便声明了一个同样的函数，也只是用于新的视图，丝毫不会对之前的视图造成任何影响。 layui.data.done 中的 done 可以随意命名，但需与 lay-done 的赋值对应上。

模板语法动态模板基于 layui 的 laytpl 模块，详细语法可见： http://www.layui.com/doc/modules/laytpl.html#syntax

登录与接口鉴权由于 layuiAdmin 接管了视图层，所以不必避免可能会与服务端分开部署，这时你有必要了解一下 layuiAdmin 默认提供的：从登录到接口鉴权，再到注销的整个流程。

登录拦截器进入登入页面登入成功后，会在 localStorage 的本地表中写入一个字段。如： access_token （名称可以在 config.js 自定义）。拦截器判断没有 access_token 时，则会跳转到登入页。尽管可以通过伪造一个假的 access_token 绕过视图层的拦截，但在请求接口时，会自动带上 access_token，服务端应再次做一层校验。

流程打开 config.js ，将 interceptor 参数设置为 true（该参数为 1.0.0-beta6 开始新增）。那么，当其未检查到 access_token 值时，会强制跳转到登录页面，以获取 access_token。打开登录对应的视图文件 views/user/login.html，在代码最下面，你将看到一段已经写好的代码，你需要的是将接口地址改为服务端的真实接口，并返回 access_token 值。 layuiAdmin 会将服务端返回的 access_token 值进行本地存储，这时你会发现 layuiAdmin 不再强制跳转到登录页面。并在后面每次请求服务端接口时，都会自动在参数和 Request Headers 中带上 access_token，以便服务端进行鉴权。若鉴权成功，顺利返回数据；若鉴权失败，服务端的 code 应返回 1001（可在 config.js 自定义）， layuiAdmin 将会自动清空本地无效 token 并跳转到登入页。退出登录：重新打开 controller/common.js，搜索 logout，配上注销接口即可。如果是在其它场景请求的接口，如：table.render()，那么你需要获取本地存储的 token 赋值给接口参数，如下：

//设置全局 table 实例的 token（这样一来，所有 table 实例均会有效） table.set({ headers: { //通过 request 头传递 access_token: layui.data(''layuiAdmin'').access_token } ,where: { //通过参数传递 access_token: layui.data(''layuiAdmin'').access_token } });

//设置单个 table 实例的 token table.render({ elem: ''#xxxx'' ,url: ''url'' ,where: { access_token: layui.data(''layuiAdmin'').access_token } //,headers: {} }); 事实上，layuiAdmin 的所有 Ajax 请求都是采用 admin.req(options)，它会自动传递 access_token，因此推荐你在 JS 执行 Ajax 请求时直接使用它。其中参数 options 和 $.ajax(options) 的参数完全一样。

接口鉴权我们推荐服务端遵循 JWT（JSON Web Token）标准进行鉴权。对 JWT 不甚了解的同学，可以去搜索一些相关资料，会极大地增加应用的可扩展性。当然，你也可以直接采用传统的 cookie / session 机制。

基础方法 config 模块你可以在任何地方通过 layui.setter 得到 config.js 中的配置信息

admin 模块 var admin = layui.admin;

admin.req(options) Ajax 请求，用法同 $.ajax(options)，只是该方法会进行错误处理和 token 的自动传递

admin.screen() 获取屏幕类型，根据当前屏幕大小，返回 0 - 3 的值 0: 低于768px的屏幕 1：768px到992px之间的屏幕 2：992px到1200px之间的屏幕 3：高于1200px的屏幕

admin.exit() 清除本地 token，并跳转到登入页

admin.sideFlexible(status) 侧边伸缩。status 为 null：收缩；status为 “spread”：展开

admin.on(eventName, callback) 事件监听，下文会有讲解

admin.popup(options) 弹出一个 layuiAdmin 主题风格的 layer 层，参数 options 跟 layer.open(options) 完全相同

admin.popupRight(options) 在屏幕右侧呼出一个面板层。options 同上。

admin.popupRight({ id: ''LAY-popup-right-new1'' //定义唯一ID，防止重复弹出 ,success: function(){ //将 views 目录下的某视图文件内容渲染给该面板 layui.view(this.id).render(''视图文件所在路径''); } }); admin.resize(callback) 窗口 resize 事件处理，我们推荐你使用该方法取代 jQuery 的 resize 事件，以避免多页面标签下可能存在的冲突。

admin.fullScreen() 全屏

admin.exitScreen() 退出全屏

admin.events

admin.events.refresh() 刷新当前右侧区域

admin.events.closeThisTabs() 关闭当前标签页

admin.events.closeOtherTabs() 关闭其它标签页

admin.events.closeAllTabs() 关闭全部标签页

view 模块 var view = layui.view;

view(id) 获取指定容器，并返回一些视图渲染的方法，如： //渲染视图，viewPath 即为视图路径 view(''id'').render(viewPath).then(function(){ //视图文件请求完毕，视图内容渲染前的回调 }).done(function(){ //视图文件请求完毕和内容渲染完毕的回调 });

//直接向容器插入 html，tpl 为模板字符；data 是传入的数据。该方法会自动完成动态模板解析 view(''id'').send(tpl, data); 另外，render 方法支持动态传参，以用于视图内容接受。如：

admin.popup({ id: ''LAY-popup-test1'' ,success: function(){ view(this.id).render(''视图文件所在路径'', { id: 123 //这里的 id 值你可以在一些事件中动态获取（如 table 模块的编辑） }); } }); 那么，在视图文件中，你可以在动态模板中通过 {{ d.params.xxx }} 得到传入的参数，如：

而如果是在 JS 语句中去获取模板传递过来的变量，可以借助动态模板的 lay-done 属性去实现，如：

然后在 JS 语句中通过执行动态模板 lay-done 中对应的方法得到对应的参数值：

注意：上述实现需保证 layuiAdmin 为 1.2.0+`

总之，驾驭好 view().render().done(callback) 对您的项目开发至关重要。

ID唯一性如果你开启了标签页功能，请务必注意 ID 的冲突，尤其是在你自己绑定事件的情况。ID 的命令可以遵循以下规则来规避冲突：

LAY-路由-任意名以消息中心页面为例，假设它的路由为：/app/message/，那么 ID 应该命名为：

<buttonid="LAY-app-message-del">删除</button>

实用组件 Hover 提示层通过对元素设置 lay-tips="提示内容" 来开启一个 hover 提示，如：

<ilay-tips="要支持的噢" lay-offset="5"></i> 其中 lay-offset 用于定于水平偏移距离（单位px），以调整箭头让其对准元素

事件监听 hash 监听路由地址改变 // 下述中的 xxx 可随意定义，不可与已经定义的 hash 事件同名，否则会覆盖上一事件 admin.on(''hash(xxx)'', function(router){ console.log(router); //得到路由信息 }); side 监听侧边伸缩 // 下述中的 xxx 可随意定义，不可与已经定义的 side 事件同名，否则会覆盖上一事件 admin.on(''side(xxx)'', function(obj){ console.log(obj.status); //得到伸缩状态：spread 为展开状态，其它值为收缩状态 });

兼容性 layuiAdmin 使用到了 layui 的栅格系统，而栅格则是基于浏览器的媒体查询。ie8、9不支持。所以要在宿主页面（如 start/index.html ）加上下面这段保证兼容：

缓存问题由于单页面版本的视图文件和静态资源模块都是动态加载的，所以可能存在浏览器的本地缓存问题，事实上我们也考虑到这个，因此，为了避免改动后的文件未及时生效，你只需在入口页面（默认为start/index.html）中，找到 layui.config ，修改其 version 的值即可。

我们推荐你分场景来更新缓存：

场景一：如果项目是在本地开发。你可以设置 version 为动态毫秒数，如： version: new Date().getTime() //这样你每次刷新页面，都会更新一次缓存场景二：如果项目是在线上运行。建议你手工更新 version，如： version: ''1.0.0'' //每次发布项目时，跟着改动下该属性值即可更新静态资源的缓存

升级事项从官网更新资源包后，除了 src 和 dist 目录需要注意一下，其它目录和文件均可覆盖，下面以 src 为例（dist 由于是 src 构建后生成的目录，所以本质是和 src 一样的） src 目录下可以直接覆盖的有：

src/lib/ src/style/ src/index.js 需要灵活调配的有：

src/controller/ src/views/ src/config.js 如果没有改动默认配置，事实上 config.js 也可以覆盖升级开发过程中，建议同时运行两个 layuiAdmin 。一个是已经实际运用的，一个是 layuiAdmin 本身的 Demo。以便从 Demo 中获取参考和提取示例。

源码构建当你在 src 目录完成开发后，你可通过 gulp 对 src 源码进行自动化构建，以生成用于线上环境的 dist 目录。并在入口页面中的 layui.config 的 base 参数指向 dist。

在资源包中根目录下看到的 gulpfile.js 是 layuiAdmin 写好的任务脚本，package.json 是任务配置文件，你只需按照以下步骤：

step1：确保你的电脑已经安装好了 Node.js，如果未安装，可去官网下载安装 step2: 命令行安装 gulp：npm install gulp -g step3：切换到 layuiAdmin 项目根目录（即 gulpfile.js 所在目录），命令行安装任务所依赖的包：npm install 安装完成后，后续只需直接执行命令：gulp 即可完成 src 到 dist 目录的构建

我们今天的关于Liferay7开发文档_1.2作为开发平台的分享已经告一段落，感谢您的关注，如果您想了解更多关于entfrm 开发平台，一个免费开源可视化的无代码开发平台、idehub云端软件开发平台与Web开发平台 Eclipse Orion介绍、JNPF快速开发平台-快速开发Web+APP项目的java开发平台、layuiadmin(iframe）开发文档的相关信息，请在本站查询。

本文标签：