二次开发文档

Jspxcms无侵入式插件开发（二次开发）教程之一：概述

Jspxcms支持无侵入式插件和二次开发，无需修改系统原有代码，即可无缝整合Entity、Service、Controller、功能菜单、权限、标签、国际化等功能。

系统中“插件--简历管理”就是以这种方式实现的，下面就以“简历管理”讲解Jspxcms插件和二次开发的方法。

本帖隐藏的内容需要回复才可以浏览

配置文件位置：/WEB-INF/conf/plugin。

所有的配置文件都必须在这个目录，在该目录下的配置文件会自动加载。在该目录下新建自己的文件夹，可以是任何名字，如：abc、novel等，本例为plug。即/WEB-INF/conf/plugin/plug

配置文件说明

application.properties：功能菜单、权限、国际化、Entity都与这个文件相关。

context-dao.xml：Dao的加载。

context-service.xml：Service的加载。

controller-back.xml：后台Controller的加载。

controller-fore.xml：前台Controller的加载。

context-directive.xml：标签的加载。

其他与插件开发相关的文件目录

/WEB-INF/messages/plugin/plug：后台国际化文件位置

/WEB-INF/messages/plugin/plugfore：前台国际化文件位置

/WEB-INF/views/plug：后台jsp文件位置

/files/1/bluewise/plug_resume.html：插件的前台模版

插件源代码包名：com.jspxcms.plug

Jspxcms无侵入式插件开发（二次开发）教程之二：菜单与权限

本帖隐藏的内容需要回复才可以浏览

菜单和权限配置文件：/WEB-INF/conf/plugin/plug/application.properties

一级菜单配置（分号为分割符）

1.menu.650=navigation.plug;nav.do?menuId=650;nav_plug

复制代码

650：是后台导航一级菜单的编号，编号大小决定菜单的前后位置。其值可以根据需要调整，如330、970，但不要与系统菜单或其他插件菜单重复。系统菜单通常为menu.100,menu.200,menu.600等，系统菜单定义文件在

/WEB-INF/conf/application.properties

navigation.plug：菜单名称。这里使用了国际化，也可以直接用中文，比如“我的插件”。

nav.do?menuId=650：菜单链接地址。其中650需与前面的值一样。

nav_plug：权限值。其中plug通常与配置文件目录名称一样。如目录为abc，则应为nav_abc。也可不一样，但不能与其他一级菜单权限名称一样。

二级菜单配置（分号为分割符）

1.menu.650.100=resume.management;plug/resume/list.do;plug:resume:list;create@plug:resume:create;copy@plug:res

ume:copy;edit@plug:resume:edit;save@plug:resume:save;update@plug:resume:update;delete@plug:resume:delete

复制代码

650：二级菜单所属的一级菜单编号。

100：二级菜单编号。其值的意义和一级菜单编号一样，用于确定二级菜单的前后位置。

resume.management：二级菜单名称。可以直接用中文，如“小说管理”。

plug/resume/list.do：功能菜单的链接地址。需与Controller中的地址对应，否则会找不到页面。

plug:resume:list：功能菜单的权限。需与Controller中list方法的权限对应，否则会报没有权限。

create@plug:resume:create：新增按钮的权限值。其中create是国际化，可以用直接用中文，如“新增@plug:resume:create”。其中plug:resume:create是该按钮的权限值，需与Controller中对应的create方法权限值一致。

copy@plug:resume:copy：意义和上面一样，后面的以此类推。

com.jspxcms.plug.web.back.ResumeController代码片段

1.package com.jspxcms.plug.web.back;

2.@Controller

3.@RequestMapping("/plug/resume")

4.public class ResumeController {

5. @RequiresPermissions("plug:resume:list")

6. @RequestMapping("list.do")

7. public String list(......) {

8. ......

9. }

10.

11. @RequiresPermissions("plug:resume:create")

12. @RequestMapping("create.do")

13. public String create(......) {

14. ......

15. }

16. ......

17.}

Jspxcms无侵入式插件开发（二次开发）教程之三：Entity

本帖隐藏的内容需要回复才可以浏览

实体类Entity配置文件：/WEB-INF/conf/plugin/plug/application.properties

1.entityManagerFactory.packagesToScan.plug=com.jspxcms.plug.domain

复制代码

plug：通常与配置文件所在目录一样，也可不一样，但不能与其他相关配置同名。

com.jspxcms.plug.domain：Entity所在包名。

不使用主键自增策略，将主键放到数据库中的一个表里。

1.create table plug_resume

2.(

3. f_resume_id int not null,

4. f_site_id int not null,

5. f_name varchar(100) not null comment '姓名',

6. f_post varchar(100) not null comment '应聘职位',

7. f_creation_date datetime not null comment '投递日期',

8. f_gender char(1) not null default 'M' comment '性别',

9. f_birth_date datetime comment '出生日期',

10. f_mobile varchar(100) comment '手机',

11. f_email varchar(100) comment '邮箱',

12. f_expected_salary int comment '期望薪水',

13. f_education_experience longtext comment '教育经历',

14. f_work_experience longtext comment '工作经历',

15. f_remark longtext comment '备注',

16. primary key (f_resume_id)

17.)

18.engine = innodb;

19.alter table plug_resume comment '简历表';

20.alter table plug_resume add constraint fk_plug_resume_site foreign key (f_site_id)

21. references cms_site (f_site_id) on delete restrict on update restrict;

复制代码

1.@Entity

2.@Table(name = "plug_resume")

3.public class Resume implements java.io.Serializable {

4. private Integer id;

5.……

6.

7. @Id

8. @Column(name = "f_resume_id", unique = true, nullable = false)

9. @TableGenerator(name = "tg_plug_resume", pkColumnValue = "plug_resume", table = "t_id_table",

pkColumnName = "f_table", valueColumnName = "f_id_value", initialValue = 1, allocationSize = 1)

10. @GeneratedValue(strategy = GenerationType.TABLE, generator = "tg_plug_resume")

11. public Integer getId() {

12. return this.id;

13. }

14.

15. public void setId(Integer id) {

16. this.id = id;

17. }

18.……

19.}

复制代码

需注意以下三个值，其中plug_resume为表名：

https://www.360docs.net/doc/593347771.html, = "tg_plug_resume", pkColumnValue = "plug_resume"

2.generator = "tg_plug_resume"

Jspxcms无侵入式插件开发（二次开发）教程之四：Dao

本帖隐藏的内容需要回复才可以浏览

Dao配置文件：/WEB-INF/conf/plugin/plug/context-dao.xml

1.

2. transaction-manager-ref="transactionManager"

3. entity-manager-factory-ref="entityManagerFactory"

4. factory-class="https://www.360docs.net/doc/593347771.html,mon.orm.MyJpaRepositoryFactoryBean"

5. repository-impl-postfix="Impl">

6.

复制代码

其中com.jspxcms.plug.repository为dao接口所在包。

Dao使用了SpringDataJPA技术。SpringDataJPA官网：http://projects.spring.io/spring-data-jpa/

1.package com.jspxcms.plug.repository;

2.public interface ResumeDao extends Repository, ResumeDaoPlus {

3. public Page findAll(Specification spec, Pageable pageable);

4. public List findAll(Specification spec, Limitable limitable);

5. public Resume findOne(Integer id);

6. public Resume save(Resume bean);

7. public void delete(Resume bean);

8.}

复制代码

ResumeDao接口中的方法不用实现。以下接口中的方法均可放到ResumeDao，且无需实现：

https://www.360docs.net/doc/593347771.html,.springframework.data.repository. CrudRepository

https://www.360docs.net/doc/593347771.html,.springframework.data.repository. PagingAndSortingRepository

https://www.360docs.net/doc/593347771.html,.springframework.data.jpa.repository. JpaRepository

https://www.360docs.net/doc/593347771.html,mon.orm. MyJpaRepository

复制代码

需要实现的dao方法，放到ResumeDaoPlus接口中。

1.package com.jspxcms.plug.repository;

2.public interface ResumeDaoPlus {

3. public List getList(Integer[] siteId, Limitable limitable);

4.}

复制代码

1.package com.jspxcms.plug.repository.impl;

2.public class ResumeDaoImpl implements ResumeDaoPlus {

3. @SuppressWarnings("unchecked")

4. public List getList(Integer[] siteId, Limitable limitable) {

5. JpqlBuilder jpql = new JpqlBuilder();

6. jpql.append("from Resume bean where 1=1");

7. if (ArrayUtils.isNotEmpty(siteId)) {

8. jpql.append(" and bean.site.id in (:siteId)");

9. jpql.setParameter("siteId", Arrays.asList(siteId));

10. }

11. return jpql.list(em, limitable);

12. }

13. private EntityManager em;

14. @PersistenceContext

15. public void setEm(EntityManager em) {

16. this.em = em;

17. }

18.}

复制代码

其中JpqlBuilder用于拼装jqpl语句、设置参数，并可处理分页问题。

https://www.360docs.net/doc/593347771.html,mon.orm.JpqlBuilder

Jspxcms无侵入式插件开发（二次开发）教程之五：Service

本帖隐藏的内容需要回复才可以浏览

Service配置文件：/WEB-INF/conf/plugin/plug/context-service.xml

1.

2.

3.expression="org.springframework.stereotype.Controller"/>

4.

复制代码

其中com.jspxcms.plug.service.impl为Service的实现类所在包。

1.package com.jspxcms.plug.service.impl;

2.@Service

3.@Transactional(readOnly = true)

4.public class ResumeServiceImpl implements ResumeService {

5. public Page findAll(Integer siteId, Map params,

6. Pageable pageable) {

7. return dao.findAll(spec(siteId, params), pageable);

8. }

9. public RowSide findSide(Integer siteId,

10. Map params, Resume bean, Integer position,

11. Sort sort) {

12. if (position == null) {

13. return new RowSide();

14. }

15. Limitable limit = RowSide.limitable(position, sort);

16. List list = dao.findAll(spec(siteId, params), limit);

17. return RowSide.create(list, bean);

18. }

19. private Specification spec(final Integer siteId,

20. Map params) {

21. Collection filters = SearchFilter.parse(params).values();

22. final Specification fsp = SearchFilter.spec(filters,

23. Resume.class);

24. Specification sp = new Specification() {

25. public Predicate toPredicate(Root root,

26. CriteriaQuery query, CriteriaBuilder cb) {

27. Predicate pred = fsp.toPredicate(root, query, cb);

28. if (siteId != null) {

29. pred = cb.and(pred, cb.equal(root.get("site")

30. . get("id"), siteId));

31. }

32. return pred;

33. }

34. };

35. return sp;

36. }

37. private ResumeDao dao;

38. @Autowired

39. public void setDao(ResumeDao dao) {

40. this.dao = dao;

41. }

42. ......

43.}

复制代码

该类使用到JPA的Specification查询方式。

可实现后台列表点击表头，按任意列排序；列表页按任意字段查询；编辑页面上一条、下一条功能。

Jspxcms无侵入式插件开发（二次开发）教程之六：Controller

本帖隐藏的内容需要回复才可以浏览

Controller后台配置文件：/WEB-INF/conf/plugin/plug/controller-back.xml

1.

2.

3.

复制代码

其中com.jspxcms.plug.web.back为后台Controller包所在位置。

1.package com.jspxcms.plug.web.back;

2.@Controller

3.@RequestMapping("/plug/resume")

4.public class ResumeController {

5. @RequiresPermissions("plug:resume:list")

6. @RequestMapping("list.do")

7. public String list(

8. @PageableDefaults(sort = "id", sortDir = Direction.DESC) Pageable pageable,

9. HttpServletRequest request, org.springframework.ui.Model modelMap) {

10. Integer siteId = Context.getCurrentSiteId(request);

11. Map params = Servlets.getParameterValuesMap(request,

12. Constants.SEARCH_PREFIX);

13. Page pagedList = service.findAll(siteId, params, pageable);

14. modelMap.addAttribute("pagedList", pagedList);

15. return "plug/resume/resume_list";

16. }

17. @RequiresPermissions("plug:resume:create")

18. @RequestMapping("create.do")

19. public String create(Integer id, org.springframework.ui.Model modelMap) {

20. if (id != null) {

21. Resume bean = service.get(id);

22. modelMap.addAttribute("bean", bean);

23. }

24. modelMap.addAttribute(OPRT, CREATE);

25. return "plug/resume/resume_form";

26. }

27. @Autowired

28. private ResumeService service;

29.}

复制代码

其中RequestMapping为访问地址，RequiresPermissions为权限代码，需与/WEB-INF/conf/plugin/plug/application.properties 中的菜单权限配置相吻合。

Controller前台配置文件：/WEB-INF/conf/plugin/plug/controller-fore.xml

1.

2.

3.

复制代码

其中com.jspxcms.plug.web. fore为前台Controller包所在位置。

1.package com.jspxcms.plug.web.fore;

2.@Controller

3.public class ResumeController {

4. public static final String TEMPLATE = "plug_resume.html";

5. @RequestMapping(value = "/resume.jspx")

6. public String resumeForm(Integer page, HttpServletRequest request,

7. org.springframework.ui.Model modelMap) {

8. Site site = Context.getCurrentSite(request);

9. Map data = modelMap.asMap();

10. ForeContext.setData(data, request);

11. ForeContext.setPage(data, page);

12. return site.getTemplate(TEMPLATE);

13. }

14. @RequestMapping(value = "/resume.jspx", method = RequestMethod.POST)

15. public String resumeSubmit(@Valid Resume bean, HttpServletRequest request,

16. HttpServletResponse response, org.springframework.ui.Model modelMap) {

17. Response resp = new Response(request, response, modelMap);

18. Site site = Context.getCurrentSite(request);

19. service.save(bean, site.getId());

20. return resp.post();

21. }

22. @Autowired

23. private ResumeService service;

24.}

复制代码

其中模版文件位置为：/files/1/bluewise/plug_resume.html

Jspxcms无侵入式插件开发（二次开发）教程之七：标签

本帖隐藏的内容需要回复才可以浏览

标签配置文件：/WEB-INF/conf/plugin/plug/controller-back.xml

1.

复制代码

在/WEB-INF/conf/plugin/plug/application.properties中加上配置：

1.freemarkerVariables.ResumeList=PlugResumeList

复制代码

其中ResumeList为标签名。

1.package com.jspxcms.plug.web.directive;

2.public class ResumeListDirective implements TemplateDirectiveModel {

3. public static final String SITE_ID = "siteId";

4.

5. @SuppressWarnings({ "rawtypes", "unchecked" })

6. public void execute(Environment env, Map params, TemplateModel[] loopVars,

7. TemplateDirectiveBody body) throws TemplateException, IOException {

8. if (loopVars.length < 1) {

9. throw new TemplateModelException("Loop variable is required.");

10. }

11. if (body == null) {

12. throw new RuntimeException("missing body");

13. }

14. Integer[] siteId = Freemarkers.getIntegers(params, SITE_ID);

15. if (siteId == null && params.get(SITE_ID) == null) {

16. siteId = new Integer[] { ForeContext.getSiteId(env) };

17. }

18. Sort defSort = new Sort(Direction.DESC, "creationDate", "id");

19. Limitable limitable = Freemarkers.getLimitable(params, defSort);

20. List list = service.findList(siteId, limitable);

21. loopVars[0] = env.getObjectWrapper().wrap(list);

22. body.render(env.getOut());

23. }

24.

25. @Autowired

26. private ResumeService service;

27.}

Jspxcms无侵入式插件开发（二次开发）教程之八：国际化

本帖隐藏的内容需要回复才可以浏览

国际化配置：在/WEB-INF/conf/plugin/plug/application.properties中加上

后台国际化文件

1.messageSource.basenames.plug=/WEB-INF/messages/plugin/plug/plug

复制代码

前台国际化文件

1.messageSource.basenames.plugfore=/WEB-INF/messages/plugin/plugfore/plugfore

复制代码

其中messageSource.basenames.plug中的plug通常为配置文件所在文件夹的名称，可以改为其他名字，但不能与其他相关配置重名。

/WEB-INF/messages/plugin/plug/plug为国际化文件所在文件夹和文件名。