How to create custom additional fields in UserProfile in MVC4
I faced with new ASP MVC 4 feature, it shipped with new membership db schema and new initialization. In mvc 3 and old versions developer able to create custom user profile fields using specifications in web.config, but now i faced with method in filters namespace in default mvc 4 project:
WebSecurity.InitializeDatabaseConnection("DefaultConnection", "UserProfile", "UserId", "UserName", autoCreateTables: true);
and user profile table:
[Table("UserProfile")]
public class UserProfile
{
[Key]
[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
public int UserId { get; set; }
public string UserName { get; set; }
}
But the method InitializeDatabaseConnection generate only UserName and UserId i need to generate other additional fields.
I have good experience in EF codeFirst approach, and in that case i try to edit UserProfile Class:
[Table("UserProfile")]
public class UserProfile
{
[Key]
[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
public int UserId { get; set; }
[Column]
[Required]
public string UserName { get; set; }
[Column]
[Required]
public string FirstName { get; set; }
[Column]
[Required]
public string LastName { get; set; }
}
But when i regenerate database, i havent see any changes, Custom Db fields not generated. Help me please, how can i create custom user fields?
Solution 1:
Elaborating from the answer above
The WebSecurity.InitializeDatabaseConnection Method help states that
If you want to use a database table that contains user profile information (user names, email addresses, and so on), you specify a connection string and table name that the membership system uses to connect to that information. If you do not want to use an existing user profile table, you can specify that the InitializeDatabaseConnection() method should automatically create the user profile table. (A database for the user profile table must already exist.)
So if we want more fields into the UserProfile table we just need to make sure we are creating a profile table and run the InitializeDatabaseConnection method after the table is already in place.
In the standard MVC4.0 project template from VS2012 I've commented out the Account controller
[Authorize]
//[InitializeSimpleMembership]
public class AccountController : Controller
{
and moved InitializeDatabaseConnection into the EF Code First Database Initializer
public class MyDatabaseInit: DropCreateDatabaseAlways<MyDatabaseContext>
{
protected override void Seed(MyDatabaseContext context)
{
SeedMembership();
}
private void SeedMembership()
{
WebSecurity.InitializeDatabaseConnection("MyDatabaseContext",
"UserProfile", "UserId", "UserName", autoCreateTables: true);
}
}
ensuring that the InitializeDatabaseConnection runs once the table is already in place.
Added the UserProfile class to my EF Code First model
public class MyDatabaseContext : DbContext
{
public DbSet<UserProfile> UserProfiles { get; set; }
protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
}
}
Added the extra field in the UserProfile table
[Table("UserProfile")]
public class UserProfile
{
[Key]
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
public int UserId { get; set; }
public string UserName { get; set; }
public string MobilePhone { get; set; }
}
All you need now is to set the database initialization strategy when the application starts and also call a query on the database the make sure it gets created at that point, before any authorization/authentication code is called.
protected void Application_Start()
{
AreaRegistration.RegisterAllAreas();
WebApiConfig.Register(GlobalConfiguration.Configuration);
FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
RouteConfig.RegisterRoutes(RouteTable.Routes);
BundleConfig.RegisterBundles(BundleTable.Bundles);
AuthConfig.RegisterAuth();
Database.SetInitializer<MyDatabaseContext>(new MyDatabaseInit());
new MyDatabaseContext().UserProfile.Find(1);
}
Solution 2:
Non-destructive version based on IMLiviu's answer and comments:
Just came across this one problem and had to unknot the correct way to do it from the answer + comments (+ trial and error), so thought I would share the results you can cut & paste. This is based on the answer by IMLiviu, so full credit to them. It modifies the existing UserProfile and UserContext classes as they appear directly compatible with EF as-is:
I was horrified to see a suggestion that involved completely removing a database, just to add a few tables so after reading all the comments and creating a prototype, here's the result.
1 - Stop Webmatrix creation
Stop the standard webmatrix creation of the membership tables (comment out the [InitializeSimpleMembership] attribute).
[Authorize]
//[InitializeSimpleMembership]
public class AccountController : Controller
2 - Create a migration configuration
Create a migration configuration class like the one below:
public class MigrationConfiguration : DbMigrationsConfiguration<UsersContext>
{
public MigrationConfiguration()
{
this.AutomaticMigrationsEnabled = true; // This is important as it will fail in some environments (like Azure) by default
}
protected override void Seed(UsersContext context)
{
WebSecurity.InitializeDatabaseConnection("DefaultConnection", "UserProfile", "UserId", "UserName", autoCreateTables: true);
}
}
3 - Remove pluralisation from EF creation
Change the AccountModel.cs file UsersContext class to remove the pluralisation option (added the OnModelCreating event):
public class UsersContext : DbContext
{
public UsersContext() : base("DefaultConnection")
{
}
public DbSet<UserProfile> UserProfiles { get; set; }
protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
}
}
4 - Add new fields to UserProfile
Add the extra fields you need to UserProfile:
[Table("UserProfile")]
public class UserProfile
{
[Key]
[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
public int UserId { get; set; }
public string UserName { get; set; }
public string UserEmail { get; set; } // <<<<<<<< E.G. THIS ADDED
}
5 - Migrate the tables on app start
Now when the app starts you set the database init strategy and trigger it with a read:
protected void Application_Start()
{
AreaRegistration.RegisterAllAreas();
WebApiConfig.Register(GlobalConfiguration.Configuration);
FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
RouteConfig.RegisterRoutes(RouteTable.Routes);
BundleConfig.RegisterBundles(BundleTable.Bundles);
AuthConfig.RegisterAuth();
Database.SetInitializer(new MigrateDatabaseToLatestVersion<UsersContext, MigrationConfiguration>());
new UsersContext().UserProfiles.Find(1);
}
Obviously you will need to add various using statements to get this all to work, but the right click resolve option will do that for you.
Additional notes:
If you decide (as I did) to use a table other than UserProfile for your users, you need to change several entries to match.
- In your
SimpleMembershipInitializerclass you need to reference the new table and column names - In the account controller and the various Login and Register views you need to reference your new model fields (if the names have changed)
- In the
UsersContextclass you can leave the Userprofile classname as-is, but you need to change theTableattribute to match your table name. - In the
UserProfileclass you need to rename the fields to match your new table field names. - In the database you need to remove the relationship between
webpages_UsersInRolesandUserProfileand add a relationship between your new user table andwebpages_UsersInRolesor the old referential integrity checks will break you at run-time. (I strongly recommend you delete the existingUserProfiletable and check it is not recreated. if it is you have something left behind in your code).