Symfony4中获取UserPasswordEncoder实例及用户实体迁移问题

Hey there, I get that you're hitting a roadblock trying to inject the UserPasswordEncoder while migrating your custom User entity (built without FOSUserBundle) to implement Symfony's UserInterface. Let's break down how to fix this auto-wiring error:

1. First, Double-Check Your User Entity Setup #

Make sure your new User class properly implements Symfony\Component\Security\Core\User\UserInterface and all required methods like getPassword(), getUsername(), getSalt() (if needed), and eraseCredentials(). This is non-negotiable for the password encoder to work with your entity.

2. Verify Your services.yaml Configuration #

Symfony4 relies on autowiring being enabled for controllers. Pop open config/services.yaml and confirm these settings are in place:

services:
    _defaults:
        autowire: true
        autoconfigure: true
        public: false

    # Auto-register all controllers in your src/Controller directory
    App\Controller\:
        resource: '../src/Controller/'
        tags: ['controller.service_arguments']

The controller.service_arguments tag tells Symfony that your controllers can accept services as method or constructor arguments—this is often the missing piece if auto-wiring fails.

3. Correctly Inject the Password Encoder (Two Approaches) #

Approach 1: Constructor Injection (Recommended Best Practice) #

Instead of injecting directly into the login() method, inject the encoder via the controller's constructor. This keeps your code cleaner and aligns with Symfony's dependency injection standards:

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;

class SecurityController extends AbstractController
{
    private $passwordEncoder;

    // Inject the encoder here
    public function __construct(UserPasswordEncoderInterface $passwordEncoder)
    {
        $this->passwordEncoder = $passwordEncoder;
    }

    public function login()
    {
        // Use the encoder wherever you need it in the controller
        // Example: $encodedPassword = $this->passwordEncoder->encodePassword($user, $plainTextPassword);
    }
}

Approach 2: Method Argument Injection #

If you prefer to inject directly into the login() method, ensure your controller is tagged correctly (from step 2) and declare the parameter with the correct type hint:

public function login(UserPasswordEncoderInterface $passwordEncoder)
{
    // Use $passwordEncoder to hash passwords here
}

If you still get an error after this, clear your Symfony cache—old cached service definitions can cause weird issues:

php bin/console cache:clear

4. Confirm Your security.yaml Encoder Setup #

Make sure your config/packages/security.yaml has the encoder configured for your User entity:

security:
    encoders:
        App\Entity\User:
            algorithm: auto # Symfony will pick the best available algorithm, or specify bcrypt/argon2i explicitly

Quick Troubleshooting Checks #

• Double-check the namespace for UserPasswordEncoderInterface—it's Symfony\Component\Security\Core\Encoder, not a custom or misspelled one.
• Don't manually override the UserPasswordEncoderInterface service in services.yaml—let Symfony handle it automatically.
• If you're using the encoder in a non-controller class (like a command or service), the same constructor injection approach works there too.

Follow these steps, and you should have the password encoder working smoothly for your User entity migration.

内容的提问来源于stack exchange，提问作者Alexandre Corvino