4 Star 8 Fork 2

Plum / plum

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Artistic-2.0

非常灵活、简单、轻量的java权限管理开源项目,能让你轻松上手并控制好所有权限 plum (体积仅有18k)

plum具有以下功能

  • 登录认证(通过ini文件配置和自由扩展获得允许直接访问的url,如资源文件和业务相关action等,其余url则必须登录后访问)
  • 权限认证(能轻松的自由扩展权限限制,简要来说就是用户是否拥有该url的访问权限,没有则跳转到配置的无权限页)
  • session管理(从程序任何地方轻易的对session进行读取和操作)
  • 《待续》

plum入门

  1. maven引入plum
    <dependency>
      <groupId>com.ljhgo</groupId>
      <artifactId>plum</artifactId>
      <version>1.0.0</version>
    </dependency>
  1. 在web.xml中配置filter(plum需配置为第一个filter)
	<filter>
		<filter-name>plum</filter-name>
		<filter-class>com.plum.filter.PlumFilter</filter-class>
	</filter>
	<filter-mapping>
		<filter-name>plum</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>
  1. 新建plum.ini文件并配置
#登录页面地址
loginUrl=/login
#未授权页面地址
unauthorizedUrl=/html/error/unauthorized.html

#自定义realm地址
realm=com.shouxun.config.realm.PlumRealm

# *号代表所有
#配置未登录时拒绝访问(如果访问的url与下面的通过表达式列表存在多个匹配,则只匹配第一个,如/assets/druid/*=deny和/assets/*=allow,当访问/assets/druid/index.html时,则匹配到/assets/druid/*=deny,所以请注意下列表达式顺序写法)
/assets/druid/*=deny
#配置在未登录下允许通过的url,未配置一律需要登录后访问
/login/*=allow
/assets/*=allow
/html/*=allow

#url需要哪些权限访问
/admin/*=roles[admin,test]

4.新建类PlumRealm并实现PlumAbstractRealm方法,以下是实际项目中实现例子,例子使用的jfinal3.3,仅供参考(记得修改plum.ini中的realm地址^-^)

//重点,实现PlumAbstractRealm的4个方法
public class PlumRealm extends PlumAbstractRealm{
	private UserProvider userService = new UserProviderImpl();
	/**
         *登陆访问规则扩展,返回null代表不扩展,扩展的是在plum.ini中的allow列表基础上在扩展
         */
        @Override
	public Map<String, String> AllowMapExt() {
		// TODO Auto-generated method stub
		return null;
	}
        
        /**
	 * 需根据自己业务实现登录认证
         * 返回null代表登录失败,不为null代表登录成功,这里返回的对象可以通过PlumSecurity.getUser()得到
	 */
	@Override
	public Object loginAuth(Map<String, Object> param) {
		String userName = (String)param.get("userName");
		String password = (String)param.get("pwd");
		UserInfo user = userService.getUser(userName);
		if(user == null)
			return null;
		if(password.equals(user.getPwd())){
			//缓存当前部门
			PlumSecurity.setAttr(Constant.SESSION_USER_ORG_KEY, OrgInfo.dao.findById(user.getOrgId()));
			return user;
		}
		
		return null;
	}

        /**
         *权限控制规则扩展,返回null代表不扩展,扩展的是在plum.ini中的roles列表基础上在扩展
         */
	@Override
	public Map<String, Set<String>> roleMapExt() {
		Map<String,Set<String>> map = new HashMap<String,Set<String>>();
		List<Record> list = startPluginAndGetRef();
		if(list!= null && !list.isEmpty()){
	        for(Record r : list){
	        	String url = r.getStr("URL");
	        	String roleId = r.getStr("ROLE_ID");
	        	if(map.containsKey(url)){
	        		Set<String> set = map.get(url);
	        		if(!set.contains(roleId)){
	        			set.add(roleId);
	        		}
	        	}else{
	        		Set<String> set = new HashSet<String>();
	        		set.add(roleId);
	        		//添加admin权限访问
	        		set.add("admin");
	        		map.put(url,set);
	        	}
	        }}
		return map;
	}

        /**
         *设置当前用户拥有的权限,return null 代表当前登陆用户没有任何权限
         */
	@Override
	public Set<String> setHaveRoles() {
                //得到当前登陆用户
		Object obj = PlumSecurity.getUser();
		if(obj==null)
			return null;
		UserInfo user = (UserInfo)obj;
		String roles = user.getRoleIds();
		if(StrKit.isBlank(roles))
			return null;
		return new HashSet<String>(Arrays.asList(roles.split(",")));
	}

	/**
	 * 从数据库查询到权限菜单关系
	 * @return
	 */
	 public static List<Record> startPluginAndGetRef() {
				Prop init = PropKit.use("init.properties");
				//是否正式环境,true为正式环境,false为测试环境,默认为true
				String path = init.getBoolean("Env",true)?"production":"dev";
				Prop jdbc = PropKit.use(File.separator +path+File.separator+ "jdbc_oracle.properties");
				// oracle
				DruidPlugin druidPlugin = new DruidPlugin(jdbc.get("master.url"), jdbc.get("master.username"), jdbc.get("master.password").trim(), jdbc.get("driver"));
				ActiveRecordPlugin masterArpOracle = new ActiveRecordPlugin("iniARP",druidPlugin);
				masterArpOracle.setContainerFactory(new CaseInsensitiveContainerFactory());
				masterArpOracle.setDialect(new OracleDialect());
				druidPlugin.start();
				Prop config = PropKit.use(path+File.separator+"config.properties");
				masterArpOracle.setShowSql(config.getBoolean("DevMode"));
				masterArpOracle.start();
				//arp.start();
				List<Record> list = Db.find("select RM.ROLE_ID,m.URL from ROLE_MENU rm,MENU m where RM.MENU_ID = m.ID and m.STATUS = ?","normal");
				 
				masterArpOracle.stop();
				druidPlugin.stop();
				return list;
			}

}

springboot使用plum,只需要新建一个类继承PlumFilter就行了,然后在添加plum.ini和realm(同上)

@WebFilter(urlPatterns = "/*")
@Order(1)
public class TestFilter extends PlumFilter {

}
Artistic License 2.0 Copyright (c) <year> <fullname> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble This license establishes the terms under which a given free software Package may be copied, modified, distributed, and/or redistributed. The intent is that the Copyright Holder maintains some artistic control over the development of that Package while still keeping the Package available as open source and free software. You are always permitted to make arrangements wholly outside of this license directly with the Copyright Holder of a given Package. If the terms of this license do not permit the full use that you propose to make of the Package, you should contact the Copyright Holder and seek a different licensing arrangement. Definitions "Copyright Holder" means the individual(s) or organization(s) named in the copyright notice for the entire Package. "Contributor" means any party that has contributed code or other material to the Package, in accordance with the Copyright Holder's procedures. "You" and "your" means any person who would like to copy, distribute, or modify the Package. "Package" means the collection of files distributed by the Copyright Holder, and derivatives of that collection and/or of those files. A given Package may consist of either the Standard Version, or a Modified Version. "Distribute" means providing a copy of the Package or making it accessible to anyone else, or in the case of a company or organization, to others outside of your company or organization. "Distributor Fee" means any fee that you charge for Distributing this Package or providing support for this Package to another party. It does not mean licensing fees. "Standard Version" refers to the Package if it has not been modified, or has been modified only in ways explicitly requested by the Copyright Holder. "Modified Version" means the Package, if it has been changed, and such changes were not explicitly requested by the Copyright Holder. "Original License" means this Artistic License as Distributed with the Standard Version of the Package, in its current version or as it may be modified by The Perl Foundation in the future. "Source" form means the source code, documentation source, and configuration files for the Package. "Compiled" form means the compiled bytecode, object code, binary, or any other form resulting from mechanical transformation or translation of the Source form. Permission for Use and Modification Without Distribution (1) You are permitted to use the Standard Version and create and use Modified Versions for any purpose without restriction, provided that you do not Distribute the Modified Version. Permissions for Redistribution of the Standard Version (2) You may Distribute verbatim copies of the Source form of the Standard Version of this Package in any medium without restriction, either gratis or for a Distributor Fee, provided that you duplicate all of the original copyright notices and associated disclaimers. At your discretion, such verbatim copies may or may not include a Compiled form of the Package. (3) You may apply any bug fixes, portability changes, and other modifications made available from the Copyright Holder. The resulting Package will still be considered the Standard Version, and as such will be subject to the Original License. Distribution of Modified Versions of the Package as Source (4) You may Distribute your Modified Version as Source (either gratis or for a Distributor Fee, and with or without a Compiled form of the Modified Version) provided that you clearly document how it differs from the Standard Version, including, but not limited to, documenting any non-standard features, executables, or modules, and provided that you do at least ONE of the following: (a) make the Modified Version available to the Copyright Holder of the Standard Version, under the Original License, so that the Copyright Holder may include your modifications in the Standard Version. (b) ensure that installation of your Modified Version does not prevent the user installing or running the Standard Version. In addition, the Modified Version must bear a name that is different from the name of the Standard Version. (c) allow anyone who receives a copy of the Modified Version to make the Source form of the Modified Version available to others under (i) the Original License or (ii) a license that permits the licensee to freely copy, modify and redistribute the Modified Version using the same licensing terms that apply to the copy that the licensee received, and requires that the Source form of the Modified Version, and of any works derived from it, be made freely available in that license fees are prohibited but Distributor Fees are allowed. Distribution of Compiled Forms of the Standard Version or Modified Versions without the Source (5) You may Distribute Compiled forms of the Standard Version without the Source, provided that you include complete instructions on how to get the Source of the Standard Version. Such instructions must be valid at the time of your distribution. If these instructions, at any time while you are carrying out such distribution, become invalid, you must provide new instructions on demand or cease further distribution. If you provide valid instructions or cease distribution within thirty days after you become aware that the instructions are invalid, then you do not forfeit any of your rights under this license. (6) You may Distribute a Modified Version in Compiled form without the Source, provided that you comply with Section 4 with respect to the Source of the Modified Version. Aggregating or Linking the Package (7) You may aggregate the Package (either the Standard Version or Modified Version) with other packages and Distribute the resulting aggregation provided that you do not charge a licensing fee for the Package. Distributor Fees are permitted, and licensing fees for other components in the aggregation are permitted. The terms of this license apply to the use and Distribution of the Standard or Modified Versions as included in the aggregation. (8) You are permitted to link Modified and Standard Versions with other works, to embed the Package in a larger work of your own, or to build stand-alone binary or bytecode versions of applications that include the Package, and Distribute the result without restriction, provided the result does not expose a direct interface to the Package. Items That are Not Considered Part of a Modified Version (9) Works (including, but not limited to, modules and scripts) that merely extend or make use of the Package, do not, by themselves, cause the Package to be a Modified Version. In addition, such works are not considered parts of the Package itself, and are not subject to the terms of this license. General Provisions (10) Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license. (11) If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license. (12) This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder. (13) This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed. (14) Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

简介

plum是一个轻量且强大的java 权限控制开源项目 展开 收起
Java
Artistic-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/lijiahong1994/plum.git
git@gitee.com:lijiahong1994/plum.git
lijiahong1994
plum
plum
master

搜索帮助