English|中文
Casbin Spring Boot Starter is designed to help you easily integrate jCasbin into your Spring Boot project.
- Add
casbin-spring-boot-starterto the Spring Boot project.
Maven
<dependency>
<groupId>org.casbin</groupId>
<artifactId>casbin-spring-boot-starter</artifactId>
<version>version</version>
</dependency>Gradle
implementation 'org.casbin:casbin-spring-boot-starter:version'- Inject the Enforcer where you need to use it
@Component
public class Test{
@Autowired
private Enforcer enforcer;
}- Add configuration
casbin:
#Whether to enable Casbin, it is enabled by default.
enableCasbin: true
#Whether to use thread-synchronized Enforcer, default false
casbin.useSyncedEnforcer: false
#Whether to enable automatic policy saving, if the adapter supports this function, it is enabled by default.
autoSave: true
#Storage type [file, jdbc], currently supported jdbc database [mysql (mariadb), h2, oracle, postgresql]
#Welcome to write and submit the jdbc adapter you are using, see: org.casbin.adapter.OracleAdapter
#The jdbc adapter will actively look for the data source information you configured in spring.datasource
#Default use jdbc, and use the built-in h2 database for memory storage
storeType: jdbc
#Data source initialization policy [create (automatically create data table, no longer initialized if created), never (always do not initialize)]
initializeSchema: create
#Local model configuration file address, the default reading location: classpath: casbin/model.conf
model: classpath:casbin/model.conf
#If the model configuration file is not found in the default location and casbin.model is not set correctly, the built-in default rbac model is used, which takes effect by default.
useDefaultModelIfModelNotSetting: true
#Local policy configuration file address, the default reading location: classpath: casbin/policy.csv
#If the configuration file is not found in the default location, an exception will be thrown.
#This configuration item takes effect only when casbin.storeType is set to file.
policy: classpath:casbin/policy.csv
#Whether to enable the CasbinWatcher mechanism, the default is not enabled.
#If the mechanism is enabled, casbin.storeType must be jdbc, otherwise the configuration is invalid.
enableWatcher: false
#CasbinWatcher notification mode, defaults to use Redis for notification synchronization, temporarily only supports Redis
#After opening Watcher, you need to manually add spring-boot-starter-data-redis dependency.
watcherType: redis- The simplest configuration
- Do not use other add-on configurations
casbin:
#If you are using a model profile at this address, no configuration is required
model: classpath:casbin/model.conf- Turn on Watcher
casbin:
#If the model profile you are using is located at this address, you do not need this configuration
model: classpath:casbin/model.conf
#When you open Watcher, the default use of RedisWatcher requires manual addition of spring-boot-starter-data-redis dependency.
enableWatcher: true